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": "The international delivery charges settings.",
411              "properties": {
412                "enabled": {
413                  "type": "boolean",
414                  "description": "Indicates whether international delivery charges are enabled."
415                },
416                "charges": {
417                  "type": "array",
418                  "description": "An array of charge arrays.",
419                  "items": {
420                    "type": "object",
421                    "description": "A charge object.",
422                    "properties": {
423                      "threshold": {
424                        "type": "integer",
425                        "description": "The threshold value."
426                      },
427                      "charges": {
428                        "type": "integer",
429                        "description": "The charge value."
430                      }
431                    }
432                  }
433                }
434              }
435            },
436            "pan_card": {
437              "type": "object",
438              "description": "The PAN card settings.",
439              "properties": {
440                "enabled": {
441                  "type": "boolean",
442                  "description": "Indicates whether PAN card is enabled."
443                },
444                "cod_threshold_amount": {
445                  "type": "integer",
446                  "description": "The COD threshold amount."
447                },
448                "online_threshold_amount": {
449                  "type": "integer",
450                  "description": "The online threshold amount."
451                }
452              }
453            },
454            "enabled": {
455              "type": "boolean",
456              "description": "Indicates whether the cart is enabled."
457            },
458            "max_cart_items": {
459              "type": "integer",
460              "description": "The maximum number of items allowed in the cart."
461            },
462            "min_cart_value": {
463              "type": "integer",
464              "description": "The minimum cart value allowed."
465            },
466            "bulk_coupons": {
467              "type": "boolean",
468              "description": "Indicates whether bulk coupons are enabled."
469            },
470            "revenue_engine_coupon": {
471              "type": "boolean",
472              "description": "Indicates whether revenue engine coupon is enabled."
473            },
474            "empty_cart": {
475              "type": "boolean",
476              "description": "Indicates whether empty cart is enabled."
477            }
478          }
479        },
480        "payment": {
481          "type": "object",
482          "description": "The payment settings.",
483          "properties": {
484            "mode_of_payment": {
485              "type": "string",
486              "description": "The mode of payment."
487            },
488            "source": {
489              "type": "string",
490              "description": "The payment source."
491            },
492            "enabled": {
493              "type": "boolean",
494              "description": "Indicates whether the payment method is enabled."
495            },
496            "callback_url": {
497              "type": "object",
498              "description": "The callback URL settings.",
499              "properties": {
500                "app": {
501                  "type": "string",
502                  "description": "The callback URL for the app."
503                },
504                "web": {
505                  "type": "string",
506                  "description": "The callback URL for the web."
507                }
508              }
509            },
510            "cod_amount_limit": {
511              "type": "integer",
512              "description": "The COD amount limit."
513            },
514            "cod_charges": {
515              "type": "integer",
516              "description": "The COD charges."
517            },
518            "anonymous_cod": {
519              "type": "boolean",
520              "description": "Indicates whether anonymous COD is enabled."
521            },
522            "user_cod_limit": {
523              "type": "integer",
524              "description": "The user COD limit."
525            },
526            "methods": {
527              "type": "object",
528              "description": "The payment methods settings.",
529              "properties": {
530                "pl": {
531                  "type": "object",
532                  "description": "The PL payment method settings.",
533                  "properties": {
534                    "enabled": {
535                      "type": "boolean",
536                      "description": "Indicates whether the PL payment method is enabled."
537                    }
538                  }
539                },
540                "card": {
541                  "type": "object",
542                  "description": "The card payment method settings.",
543                  "properties": {
544                    "enabled": {
545                      "type": "boolean",
546                      "description": "Indicates whether the card payment method is enabled."
547                    }
548                  }
549                },
550                "nb": {
551                  "type": "object",
552                  "description": "The NB payment method settings.",
553                  "properties": {
554                    "enabled": {
555                      "type": "boolean",
556                      "description": "Indicates whether the NB payment method is enabled."
557                    }
558                  }
559                },
560                "wl": {
561                  "type": "object",
562                  "description": "The WL payment method settings.",
563                  "properties": {
564                    "enabled": {
565                      "type": "boolean",
566                      "description": "Indicates whether the WL payment method is enabled."
567                    }
568                  }
569                },
570                "ps": {
571                  "type": "object",
572                  "description": "The PS payment method settings.",
573                  "properties": {
574                    "enabled": {
575                      "type": "boolean",
576                      "description": "Indicates whether the PS payment method is enabled."
577                    }
578                  }
579                },
580                "upi": {
581                  "type": "object",
582                  "description": "The UPI payment method settings.",
583                  "properties": {
584                    "enabled": {
585                      "type": "boolean",
586                      "description": "Indicates whether the UPI payment method is enabled."
587                    }
588                  }
589                },
590                "qr": {
591                  "type": "object",
592                  "description": "The QR payment method settings.",
593                  "properties": {
594                    "enabled": {
595                      "type": "boolean",
596                      "description": "Indicates whether the QR payment method is enabled."
597                    }
598                  }
599                },
600                "cod": {
601                  "type": "object",
602                  "description": "The COD payment method settings.",
603                  "properties": {
604                    "enabled": {
605                      "type": "boolean",
606                      "description": "Indicates whether the COD payment method is enabled."
607                    }
608                  }
609                },
610                "pp": {
611                  "type": "object",
612                  "description": "The PP payment method settings.",
613                  "properties": {
614                    "enabled": {
615                      "type": "boolean",
616                      "description": "Indicates whether the PP payment method is enabled."
617                    }
618                  }
619                },
620                "jp": {
621                  "type": "object",
622                  "description": "The JP payment method settings.",
623                  "properties": {
624                    "enabled": {
625                      "type": "boolean",
626                      "description": "Indicates whether the JP payment method is enabled."
627                    }
628                  }
629                },
630                "pac": {
631                  "type": "object",
632                  "description": "The PAC payment method settings.",
633                  "properties": {
634                    "enabled": {
635                      "type": "boolean",
636                      "description": "Indicates whether the PAC payment method is enabled."
637                    }
638                  }
639                },
640                "fc": {
641                  "type": "object",
642                  "description": "The FC payment method settings.",
643                  "properties": {
644                    "enabled": {
645                      "type": "boolean",
646                      "description": "Indicates whether the FC payment method is enabled."
647                    }
648                  }
649                },
650                "jiopp": {
651                  "type": "object",
652                  "description": "The JIOPP payment method settings.",
653                  "properties": {
654                    "enabled": {
655                      "type": "boolean",
656                      "description": "Indicates whether the JIOPP payment method is enabled."
657                    }
658                  }
659                },
660                "stripepg": {
661                  "type": "object",
662                  "description": "The StripePG payment method settings.",
663                  "properties": {
664                    "enabled": {
665                      "type": "boolean",
666                      "description": "Indicates whether the StripePG payment method is enabled."
667                    }
668                  }
669                },
670                "juspaypg": {
671                  "type": "object",
672                  "description": "The JuspayPG payment method settings.",
673                  "properties": {
674                    "enabled": {
675                      "type": "boolean",
676                      "description": "Indicates whether the JuspayPG payment method is enabled."
677                    }
678                  }
679                },
680                "payubizpg": {
681                  "type": "object",
682                  "description": "The PayubizPG payment method settings.",
683                  "properties": {
684                    "enabled": {
685                      "type": "boolean",
686                      "description": "Indicates whether the PayubizPG payment method is enabled."
687                    }
688                  }
689                },
690                "payumoneypg": {
691                  "type": "object",
692                  "description": "The PayumoneyPG payment method settings.",
693                  "properties": {
694                    "enabled": {
695                      "type": "boolean",
696                      "description": "Indicates whether the PayumoneyPG payment method is enabled."
697                    }
698                  }
699                },
700                "rupifipg": {
701                  "type": "object",
702                  "description": "The RupifiPG payment method settings.",
703                  "properties": {
704                    "enabled": {
705                      "type": "boolean",
706                      "description": "Indicates whether the RupifiPG payment method is enabled."
707                    }
708                  }
709                },
710                "simpl": {
711                  "type": "object",
712                  "description": "The Simpl payment method settings.",
713                  "properties": {
714                    "enabled": {
715                      "type": "boolean",
716                      "description": "Indicates whether the Simpl payment method is enabled."
717                    }
718                  }
719                }
720              }
721            },
722            "payment_selection_lock": {
723              "type": "object",
724              "description": "The payment selection lock settings.",
725              "properties": {
726                "enabled": {
727                  "type": "boolean",
728                  "description": "Indicates whether payment selection lock is enabled."
729                },
730                "default_options": {
731                  "type": "string",
732                  "description": "The default payment options."
733                },
734                "payment_identifier": {
735                  "type": "string",
736                  "description": "The payment identifier."
737                }
738              }
739            }
740          },
741          "required": [
742            "mode_of_payment",
743            "source"
744          ]
745        },
746        "order": {
747          "type": "object",
748          "description": "The order settings.",
749          "properties": {
750            "enabled": {
751              "type": "boolean",
752              "description": "Indicates whether orders are enabled."
753            },
754            "force_reassignment": {
755              "type": "boolean",
756              "description": "Indicates whether force reassignment is enabled."
757            },
758            "message": {
759              "type": "string",
760              "description": "The order message."
761            }
762          }
763        },
764        "comms_enabled": {
765          "type": "boolean",
766          "description": "Indicates whether communications are enabled."
767        },
768        "communication": {
769          "type": "object",
770          "description": "The communication settings.",
771          "properties": {
772            "email": {
773              "type": "object",
774              "description": "The email settings.",
775              "properties": {
776                "enabled": {
777                  "type": "boolean",
778                  "description": "Indicates whether email communication is enabled."
779                }
780              }
781            },
782            "sms": {
783              "type": "object",
784              "description": "The SMS settings.",
785              "properties": {
786                "enabled": {
787                  "type": "boolean",
788                  "description": "Indicates whether SMS communication is enabled."
789                }
790              }
791            },
792            "voice": {
793              "type": "object",
794              "description": "The voice settings.",
795              "properties": {
796                "enabled": {
797                  "type": "boolean",
798                  "description": "Indicates whether voice communication is enabled."
799                }
800              }
801            }
802          }
803        },
804        "platforms": {
805          "type": "array",
806          "description": "An array of platform types.",
807          "items": {
808            "type": "string",
809            "description": "The type of a platform."
810          }
811        },
812        "logistics": {
813          "type": "object",
814          "description": "The logistics settings.",
815          "properties": {
816            "logistics_by_seller": {
817              "type": "boolean",
818              "description": "Indicates whether logistics are managed by the seller."
819            },
820            "serviceability_check": {
821              "type": "boolean",
822              "description": "Indicates whether serviceability check is enabled."
823            },
824            "same_day_delivery": {
825              "type": "boolean",
826              "description": "Indicates whether same day delivery is enabled."
827            },
828            "dp_assignment": {
829              "type": "boolean",
830              "description": "Indicates whether DP assignment is enabled."
831            }
832          }
833        },
834        "pii_masking": {
835          "type": "object",
836          "description": "The PII masking settings.",
837          "properties": {
838            "enabled": {
839              "type": "boolean",
840              "description": "Indicates whether PII masking is enabled."
841            }
842          }
843        },
844        "tags": {
845          "type": "array",
846          "description": "An array of tags.",
847          "items": {
848            "type": "string",
849            "description": "A tag."
850          }
851        },
852        "_id": {
853          "type": "string",
854          "description": "The ID of the payload."
855        },
856        "modified_by": {
857          "type": "string",
858          "description": "The user who last modified the payload."
859        },
860        "created_at": {
861          "type": "string",
862          "description": "The creation date of the payload."
863        },
864        "modified_at": {
865          "type": "string",
866          "description": "The last modification date of the payload."
867        },
868        "__v": {
869          "type": "integer",
870          "description": "The version number of the payload."
871        }
872      },
873      "required": [
874        "app",
875        "business",
876        "_id"
877      ]
878    }
879  }
880}
Payload Example
1{
2  "application_id": [
3    "660d8c6865638760213b78c6",
4    "*"
5  ],
6  "company_id": 3,
7  "contains": [
8    "app",
9    "business",
10    "inventory",
11    "authentication",
12    "article_assignment",
13    "reward_points",
14    "cart",
15    "payment",
16    "order",
17    "comms_enabled",
18    "communication",
19    "platforms",
20    "logistics",
21    "pii_masking",
22    "tags",
23    "_id",
24    "modified_by",
25    "created_at",
26    "modified_at",
27    "__v"
28  ],
29  "event": {
30    "category": "application",
31    "created_timestamp": 1712163944281,
32    "id": "hDZA6oUeMD8FStFI5pikYNrcI3BnMO7w9nBzkuOXfaY=",
33    "name": "configuration",
34    "trace_id": [
35      "slingshot.68774491-f1dc-11ee-bd36-63deb585f515"
36    ],
37    "type": "create",
38    "version": "1"
39  },
40  "payload": {
41    "__v": 0,
42    "_id": "660d8c6865638760213b78c8",
43    "app": "660d8c6865638760213b78c6",
44    "article_assignment": {
45      "enforced_stores": [],
46      "post_order_reassignment": true,
47      "rules": {
48        "store_priority": {
49          "enabled": false,
50          "storetype_order": []
51        }
52      }
53    },
54    "authentication": {
55      "provider": "fynd",
56      "required": false
57    },
58    "business": "retail",
59    "cart": {
60      "bulk_coupons": false,
61      "delivery_charges": {
62        "charges": [],
63        "enabled": false
64      },
65      "enabled": true,
66      "international_delivery_charges": {
67        "charges": [],
68        "enabled": false
69      },
70      "max_cart_items": 50,
71      "min_cart_value": 0,
72      "pan_card": {
73        "cod_threshold_amount": 0,
74        "online_threshold_amount": 0
75      },
76      "revenue_engine_coupon": false
77    },
78    "comms_enabled": true,
79    "communication": {
80      "email": {
81        "enabled": true
82      },
83      "sms": {
84        "enabled": true
85      },
86      "voice": {
87        "enabled": true
88      }
89    },
90    "created_at": "2024-04-03T17:05:44.255Z",
91    "inventory": {
92      "brand": {
93        "brands": [],
94        "criteria": "all"
95      },
96      "category": {
97        "categories": [],
98        "criteria": "all"
99      },
100      "company_id": 3,
101      "company_store": [],
102      "discount": {
103        "max": -1,
104        "min": 0
105      },
106      "exclude_category": [],
107      "franchise_enabled": false,
108      "image": [
109        "standard",
110        "substandard",
111        "default"
112      ],
113      "only_verified_products": false,
114      "out_of_stock": false,
115      "price": {
116        "max": -1,
117        "min": 1
118      },
119      "store": {
120        "criteria": "filter",
121        "rules": [
122          {
123            "brands": [],
124            "companies": [
125              3
126            ]
127          }
128        ],
129        "stores": []
130      }
131    },
132    "logistics": {
133      "dp_assignment": true,
134      "logistics_by_seller": false,
135      "same_day_delivery": true,
136      "serviceability_check": true
137    },
138    "modified_at": "2024-04-03T17:05:44.255Z",
139    "modified_by": "8560eb30f83b6cda66aa235d",
140    "order": {
141      "enabled": true,
142      "force_reassignment": false,
143      "message": ""
144    },
145    "payment": {
146      "anonymous_cod": false,
147      "callback_url": {
148        "app": "",
149        "web": ""
150      },
151      "cod_amount_limit": 49000,
152      "cod_charges": 0,
153      "enabled": true,
154      "methods": {
155        "card": {
156          "enabled": true
157        },
158        "cod": {
159          "enabled": true
160        },
161        "fc": {
162          "enabled": false
163        },
164        "jiopp": {
165          "enabled": false
166        },
167        "jp": {
168          "enabled": false
169        },
170        "juspaypg": {
171          "enabled": false
172        },
173        "nb": {
174          "enabled": true
175        },
176        "pac": {
177          "enabled": false
178        },
179        "payubizpg": {
180          "enabled": false
181        },
182        "payumoneypg": {
183          "enabled": false
184        },
185        "pl": {
186          "enabled": true
187        },
188        "pp": {
189          "enabled": false
190        },
191        "ps": {
192          "enabled": true
193        },
194        "qr": {
195          "enabled": true
196        },
197        "rupifipg": {
198          "enabled": false
199        },
200        "simpl": {
201          "enabled": true
202        },
203        "stripepg": {
204          "enabled": false
205        },
206        "upi": {
207          "enabled": true
208        },
209        "wl": {
210          "enabled": true
211        }
212      },
213      "mode_of_payment": "ECOMM",
214      "payment_selection_lock": {
215        "default_options": "cod",
216        "enabled": false,
217        "payment_identifier": "cod"
218      },
219      "source": "ECOMM",
220      "user_cod_limit": 0
221    },
222    "pii_masking": {
223      "enabled": false
224    },
225    "platforms": [],
226    "reward_points": {
227      "credit": {
228        "enabled": false
229      },
230      "debit": {
231        "auto_apply": false,
232        "enabled": false,
233        "strategy_channel": ""
234      }
235    },
236    "tags": []
237  }
238}

application/configuration/update/v1

this event is triggered when configuration 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
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.
old_payload
object
Required
The old payload schema.
Properties
inventory
object
Inventory details.
Properties
company_id
integer
The company ID.
out_of_stock
boolean
Indicates whether the product is out of stock.
franchise_enabled
boolean
Indicates whether franchise is enabled.
brand
object
Brand details.
Properties
criteria
string
Required
The criteria for the brand.
brands
array of integer
List of brand IDs.
store
object
Store details.
Properties
criteria
string
Required
The criteria for the store.
rules
array of object
List of rules for the store.
Array of Properties
companies
array of integer
List of company IDs for the rule.
brands
array of integer
List of brand IDs for the rule.
stores
array of integer
List of store IDs.
image
array of string
List of image URLs.
only_verified_products
boolean
Indicates whether only verified products are included.
category
object
Category details.
Properties
criteria
string
Required
The criteria for the category.
categories
array of integer
List of category IDs.
exclude_category
array of integer
List of category IDs to be excluded.
price
object
Price range details.
Properties
min
integer
Required
The minimum value of the price range.
max
integer
Required
The maximum value of the price range.
discount
object
Discount details.
Properties
min
integer
Required
The minimum value of the discount.
max
integer
Required
The maximum value of the discount.
company_store
array of integer
List of company store IDs associated with 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": "The international delivery charges settings.",
411              "properties": {
412                "enabled": {
413                  "type": "boolean",
414                  "description": "Indicates whether international delivery charges are enabled."
415                },
416                "charges": {
417                  "type": "array",
418                  "description": "An array of charge arrays.",
419                  "items": {
420                    "type": "object",
421                    "description": "A charge object.",
422                    "properties": {
423                      "threshold": {
424                        "type": "integer",
425                        "description": "The threshold value."
426                      },
427                      "charges": {
428                        "type": "integer",
429                        "description": "The charge value."
430                      }
431                    }
432                  }
433                }
434              }
435            },
436            "pan_card": {
437              "type": "object",
438              "description": "The PAN card settings.",
439              "properties": {
440                "enabled": {
441                  "type": "boolean",
442                  "description": "Indicates whether PAN card is enabled."
443                },
444                "cod_threshold_amount": {
445                  "type": "integer",
446                  "description": "The COD threshold amount."
447                },
448                "online_threshold_amount": {
449                  "type": "integer",
450                  "description": "The online threshold amount."
451                }
452              }
453            },
454            "enabled": {
455              "type": "boolean",
456              "description": "Indicates whether the cart is enabled."
457            },
458            "max_cart_items": {
459              "type": "integer",
460              "description": "The maximum number of items allowed in the cart."
461            },
462            "min_cart_value": {
463              "type": "integer",
464              "description": "The minimum cart value allowed."
465            },
466            "bulk_coupons": {
467              "type": "boolean",
468              "description": "Indicates whether bulk coupons are enabled."
469            },
470            "revenue_engine_coupon": {
471              "type": "boolean",
472              "description": "Indicates whether revenue engine coupon is enabled."
473            },
474            "empty_cart": {
475              "type": "boolean",
476              "description": "Indicates whether empty cart is enabled."
477            }
478          }
479        },
480        "payment": {
481          "type": "object",
482          "description": "The payment settings.",
483          "properties": {
484            "mode_of_payment": {
485              "type": "string",
486              "description": "The mode of payment."
487            },
488            "source": {
489              "type": "string",
490              "description": "The payment source."
491            },
492            "enabled": {
493              "type": "boolean",
494              "description": "Indicates whether the payment method is enabled."
495            },
496            "callback_url": {
497              "type": "object",
498              "description": "The callback URL settings.",
499              "properties": {
500                "app": {
501                  "type": "string",
502                  "description": "The callback URL for the app."
503                },
504                "web": {
505                  "type": "string",
506                  "description": "The callback URL for the web."
507                }
508              }
509            },
510            "cod_amount_limit": {
511              "type": "integer",
512              "description": "The COD amount limit."
513            },
514            "cod_charges": {
515              "type": "integer",
516              "description": "The COD charges."
517            },
518            "anonymous_cod": {
519              "type": "boolean",
520              "description": "Indicates whether anonymous COD is enabled."
521            },
522            "user_cod_limit": {
523              "type": "integer",
524              "description": "The user COD limit."
525            },
526            "methods": {
527              "type": "object",
528              "description": "The payment methods settings.",
529              "properties": {
530                "pl": {
531                  "type": "object",
532                  "description": "The PL payment method settings.",
533                  "properties": {
534                    "enabled": {
535                      "type": "boolean",
536                      "description": "Indicates whether the PL payment method is enabled."
537                    }
538                  }
539                },
540                "card": {
541                  "type": "object",
542                  "description": "The card payment method settings.",
543                  "properties": {
544                    "enabled": {
545                      "type": "boolean",
546                      "description": "Indicates whether the card payment method is enabled."
547                    }
548                  }
549                },
550                "nb": {
551                  "type": "object",
552                  "description": "The NB payment method settings.",
553                  "properties": {
554                    "enabled": {
555                      "type": "boolean",
556                      "description": "Indicates whether the NB payment method is enabled."
557                    }
558                  }
559                },
560                "wl": {
561                  "type": "object",
562                  "description": "The WL payment method settings.",
563                  "properties": {
564                    "enabled": {
565                      "type": "boolean",
566                      "description": "Indicates whether the WL payment method is enabled."
567                    }
568                  }
569                },
570                "ps": {
571                  "type": "object",
572                  "description": "The PS payment method settings.",
573                  "properties": {
574                    "enabled": {
575                      "type": "boolean",
576                      "description": "Indicates whether the PS payment method is enabled."
577                    }
578                  }
579                },
580                "upi": {
581                  "type": "object",
582                  "description": "The UPI payment method settings.",
583                  "properties": {
584                    "enabled": {
585                      "type": "boolean",
586                      "description": "Indicates whether the UPI payment method is enabled."
587                    }
588                  }
589                },
590                "qr": {
591                  "type": "object",
592                  "description": "The QR payment method settings.",
593                  "properties": {
594                    "enabled": {
595                      "type": "boolean",
596                      "description": "Indicates whether the QR payment method is enabled."
597                    }
598                  }
599                },
600                "cod": {
601                  "type": "object",
602                  "description": "The COD payment method settings.",
603                  "properties": {
604                    "enabled": {
605                      "type": "boolean",
606                      "description": "Indicates whether the COD payment method is enabled."
607                    }
608                  }
609                },
610                "pp": {
611                  "type": "object",
612                  "description": "The PP payment method settings.",
613                  "properties": {
614                    "enabled": {
615                      "type": "boolean",
616                      "description": "Indicates whether the PP payment method is enabled."
617                    }
618                  }
619                },
620                "jp": {
621                  "type": "object",
622                  "description": "The JP payment method settings.",
623                  "properties": {
624                    "enabled": {
625                      "type": "boolean",
626                      "description": "Indicates whether the JP payment method is enabled."
627                    }
628                  }
629                },
630                "pac": {
631                  "type": "object",
632                  "description": "The PAC payment method settings.",
633                  "properties": {
634                    "enabled": {
635                      "type": "boolean",
636                      "description": "Indicates whether the PAC payment method is enabled."
637                    }
638                  }
639                },
640                "fc": {
641                  "type": "object",
642                  "description": "The FC payment method settings.",
643                  "properties": {
644                    "enabled": {
645                      "type": "boolean",
646                      "description": "Indicates whether the FC payment method is enabled."
647                    }
648                  }
649                },
650                "jiopp": {
651                  "type": "object",
652                  "description": "The JIOPP payment method settings.",
653                  "properties": {
654                    "enabled": {
655                      "type": "boolean",
656                      "description": "Indicates whether the JIOPP payment method is enabled."
657                    }
658                  }
659                },
660                "stripepg": {
661                  "type": "object",
662                  "description": "The StripePG payment method settings.",
663                  "properties": {
664                    "enabled": {
665                      "type": "boolean",
666                      "description": "Indicates whether the StripePG payment method is enabled."
667                    }
668                  }
669                },
670                "juspaypg": {
671                  "type": "object",
672                  "description": "The JuspayPG payment method settings.",
673                  "properties": {
674                    "enabled": {
675                      "type": "boolean",
676                      "description": "Indicates whether the JuspayPG payment method is enabled."
677                    }
678                  }
679                },
680                "payubizpg": {
681                  "type": "object",
682                  "description": "The PayubizPG payment method settings.",
683                  "properties": {
684                    "enabled": {
685                      "type": "boolean",
686                      "description": "Indicates whether the PayubizPG payment method is enabled."
687                    }
688                  }
689                },
690                "payumoneypg": {
691                  "type": "object",
692                  "description": "The PayumoneyPG payment method settings.",
693                  "properties": {
694                    "enabled": {
695                      "type": "boolean",
696                      "description": "Indicates whether the PayumoneyPG payment method is enabled."
697                    }
698                  }
699                },
700                "rupifipg": {
701                  "type": "object",
702                  "description": "The RupifiPG payment method settings.",
703                  "properties": {
704                    "enabled": {
705                      "type": "boolean",
706                      "description": "Indicates whether the RupifiPG payment method is enabled."
707                    }
708                  }
709                },
710                "simpl": {
711                  "type": "object",
712                  "description": "The Simpl payment method settings.",
713                  "properties": {
714                    "enabled": {
715                      "type": "boolean",
716                      "description": "Indicates whether the Simpl payment method is enabled."
717                    }
718                  }
719                }
720              }
721            },
722            "payment_selection_lock": {
723              "type": "object",
724              "description": "The payment selection lock settings.",
725              "properties": {
726                "enabled": {
727                  "type": "boolean",
728                  "description": "Indicates whether payment selection lock is enabled."
729                },
730                "default_options": {
731                  "type": "string",
732                  "description": "The default payment options."
733                },
734                "payment_identifier": {
735                  "type": "string",
736                  "description": "The payment identifier."
737                }
738              }
739            }
740          },
741          "required": [
742            "mode_of_payment",
743            "source"
744          ]
745        },
746        "order": {
747          "type": "object",
748          "description": "The order settings.",
749          "properties": {
750            "enabled": {
751              "type": "boolean",
752              "description": "Indicates whether orders are enabled."
753            },
754            "force_reassignment": {
755              "type": "boolean",
756              "description": "Indicates whether force reassignment is enabled."
757            },
758            "message": {
759              "type": "string",
760              "description": "The order message."
761            }
762          }
763        },
764        "comms_enabled": {
765          "type": "boolean",
766          "description": "Indicates whether communications are enabled."
767        },
768        "communication": {
769          "type": "object",
770          "description": "The communication settings.",
771          "properties": {
772            "email": {
773              "type": "object",
774              "description": "The email settings.",
775              "properties": {
776                "enabled": {
777                  "type": "boolean",
778                  "description": "Indicates whether email communication is enabled."
779                }
780              }
781            },
782            "sms": {
783              "type": "object",
784              "description": "The SMS settings.",
785              "properties": {
786                "enabled": {
787                  "type": "boolean",
788                  "description": "Indicates whether SMS communication is enabled."
789                }
790              }
791            },
792            "voice": {
793              "type": "object",
794              "description": "The voice settings.",
795              "properties": {
796                "enabled": {
797                  "type": "boolean",
798                  "description": "Indicates whether voice communication is enabled."
799                }
800              }
801            }
802          }
803        },
804        "platforms": {
805          "type": "array",
806          "description": "An array of platform types.",
807          "items": {
808            "type": "string",
809            "description": "The type of a platform."
810          }
811        },
812        "logistics": {
813          "type": "object",
814          "description": "The logistics settings.",
815          "properties": {
816            "logistics_by_seller": {
817              "type": "boolean",
818              "description": "Indicates whether logistics are managed by the seller."
819            },
820            "serviceability_check": {
821              "type": "boolean",
822              "description": "Indicates whether serviceability check is enabled."
823            },
824            "same_day_delivery": {
825              "type": "boolean",
826              "description": "Indicates whether same day delivery is enabled."
827            },
828            "dp_assignment": {
829              "type": "boolean",
830              "description": "Indicates whether DP assignment is enabled."
831            }
832          }
833        },
834        "pii_masking": {
835          "type": "object",
836          "description": "The PII masking settings.",
837          "properties": {
838            "enabled": {
839              "type": "boolean",
840              "description": "Indicates whether PII masking is enabled."
841            }
842          }
843        },
844        "tags": {
845          "type": "array",
846          "description": "An array of tags.",
847          "items": {
848            "type": "string",
849            "description": "A tag."
850          }
851        },
852        "_id": {
853          "type": "string",
854          "description": "The ID of the payload."
855        },
856        "modified_by": {
857          "type": "string",
858          "description": "The user who last modified the payload."
859        },
860        "created_at": {
861          "type": "string",
862          "description": "The creation date of the payload."
863        },
864        "modified_at": {
865          "type": "string",
866          "description": "The last modification date of the payload."
867        },
868        "__v": {
869          "type": "integer",
870          "description": "The version number of the payload."
871        },
872        "old_payload": {
873          "type": "object",
874          "description": "The old payload schema.",
875          "properties": {
876            "inventory": {
877              "type": "object",
878              "description": "Inventory details.",
879              "properties": {
880                "company_id": {
881                  "type": "integer",
882                  "description": "The company ID."
883                },
884                "out_of_stock": {
885                  "type": "boolean",
886                  "description": "Indicates whether the product is out of stock."
887                },
888                "franchise_enabled": {
889                  "type": "boolean",
890                  "description": "Indicates whether franchise is enabled."
891                },
892                "brand": {
893                  "type": "object",
894                  "description": "Brand details.",
895                  "properties": {
896                    "criteria": {
897                      "type": "string",
898                      "description": "The criteria for the brand."
899                    },
900                    "brands": {
901                      "type": "array",
902                      "description": "List of brand IDs.",
903                      "items": {
904                        "type": "integer",
905                        "description": "The ID of a brand."
906                      }
907                    }
908                  },
909                  "required": [
910                    "criteria"
911                  ]
912                },
913                "store": {
914                  "type": "object",
915                  "description": "Store details.",
916                  "properties": {
917                    "criteria": {
918                      "type": "string",
919                      "description": "The criteria for the store."
920                    },
921                    "rules": {
922                      "type": "array",
923                      "description": "List of rules for the store.",
924                      "items": {
925                        "type": "object",
926                        "description": "Store rule.",
927                        "properties": {
928                          "companies": {
929                            "type": "array",
930                            "description": "List of company IDs for the rule.",
931                            "items": {
932                              "type": "integer",
933                              "description": "The ID of a company."
934                            }
935                          },
936                          "brands": {
937                            "type": "array",
938                            "description": "List of brand IDs for the rule.",
939                            "items": {
940                              "type": "integer",
941                              "description": "The ID of a brand."
942                            }
943                          }
944                        }
945                      }
946                    },
947                    "stores": {
948                      "type": "array",
949                      "description": "List of store IDs.",
950                      "items": {
951                        "type": "integer",
952                        "description": "The ID of a store."
953                      }
954                    }
955                  },
956                  "required": [
957                    "criteria"
958                  ]
959                },
960                "image": {
961                  "type": "array",
962                  "description": "List of image URLs.",
963                  "items": {
964                    "type": "string",
965                    "description": "The URL of an image."
966                  }
967                },
968                "only_verified_products": {
969                  "type": "boolean",
970                  "description": "Indicates whether only verified products are included."
971                },
972                "category": {
973                  "type": "object",
974                  "description": "Category details.",
975                  "properties": {
976                    "criteria": {
977                      "type": "string",
978                      "description": "The criteria for the category."
979                    },
980                    "categories": {
981                      "type": "array",
982                      "description": "List of category IDs.",
983                      "items": {
984                        "type": "integer",
985                        "description": "The ID of a category."
986                      }
987                    }
988                  },
989                  "required": [
990                    "criteria"
991                  ]
992                },
993                "exclude_category": {
994                  "type": "array",
995                  "description": "List of category IDs to be excluded.",
996                  "items": {
997                    "type": "integer",
998                    "description": "The ID of a category."
999                  }
1000                },
1001                "price": {
1002                  "type": "object",
1003                  "description": "Price range details.",
1004                  "properties": {
1005                    "min": {
1006                      "type": "integer",
1007                      "description": "The minimum value of the price range."
1008                    },
1009                    "max": {
1010                      "type": "integer",
1011                      "description": "The maximum value of the price range."
1012                    }
1013                  },
1014                  "required": [
1015                    "min",
1016                    "max"
1017                  ]
1018                },
1019                "discount": {
1020                  "type": "object",
1021                  "description": "Discount details.",
1022                  "properties": {
1023                    "min": {
1024                      "type": "integer",
1025                      "description": "The minimum value of the discount."
1026                    },
1027                    "max": {
1028                      "type": "integer",
1029                      "description": "The maximum value of the discount."
1030                    }
1031                  },
1032                  "required": [
1033                    "min",
1034                    "max"
1035                  ]
1036                },
1037                "company_store": {
1038                  "type": "array",
1039                  "description": "List of company store IDs associated with the payload.",
1040                  "items": {
1041                    "type": "integer",
1042                    "description": "The ID of a company store."
1043                  }
1044                }
1045              }
1046            }
1047          }
1048        }
1049      },
1050      "required": [
1051        "app",
1052        "business",
1053        "_id",
1054        "old_payload"
1055      ]
1056    }
1057  }
1058}
Payload Example
1{
2  "application_id": [
3    "643e93f5ffc8101656a5629b",
4    "*"
5  ],
6  "company_id": 261,
7  "contains": [
8    "inventory",
9    "authentication",
10    "article_assignment",
11    "reward_points",
12    "cart",
13    "payment",
14    "order",
15    "communication",
16    "logistics",
17    "pii_masking",
18    "_id",
19    "app",
20    "business",
21    "comms_enabled",
22    "platforms",
23    "tags",
24    "modified_by",
25    "created_at",
26    "modified_at",
27    "__v",
28    "old_payload"
29  ],
30  "event": {
31    "category": "application",
32    "created_timestamp": 1712043192353,
33    "id": "8WGM9q/6zYmuYJRawnO2mQDk5iRbybs/x0qB1UUaNXM=",
34    "name": "configuration",
35    "trace_id": [
36      "slingshot.42b54910-f0c3-11ee-aea4-992bbd28a971"
37    ],
38    "type": "update",
39    "version": "1"
40  },
41  "payload": {
42    "__v": 5,
43    "_id": "643e93f5ffc8101656a5629d",
44    "app": "643e93f5ffc8101656a5629b",
45    "article_assignment": {
46      "enforced_stores": [],
47      "post_order_reassignment": true,
48      "rules": {
49        "store_priority": {
50          "enabled": false,
51          "storetype_order": []
52        }
53      }
54    },
55    "authentication": {
56      "provider": "fynd",
57      "required": false
58    },
59    "business": "retail",
60    "cart": {
61      "bulk_coupons": false,
62      "delivery_charges": {
63        "charges": [
64          {
65            "charges": 0,
66            "threshold": 5000
67          },
68          {
69            "charges": 0,
70            "threshold": 31230
71          }
72        ],
73        "enabled": true
74      },
75      "enabled": true,
76      "international_delivery_charges": {
77        "charges": [],
78        "enabled": false
79      },
80      "max_cart_items": 0,
81      "min_cart_value": 0,
82      "pan_card": {
83        "cod_threshold_amount": 50000,
84        "enabled": true,
85        "online_threshold_amount": 100000
86      },
87      "revenue_engine_coupon": true
88    },
89    "comms_enabled": true,
90    "communication": {
91      "email": {
92        "enabled": true
93      },
94      "sms": {
95        "enabled": true
96      },
97      "voice": {
98        "enabled": true
99      }
100    },
101    "created_at": "2023-04-18T12:58:29.147Z",
102    "inventory": {
103      "brand": {
104        "brands": [
105          11,
106          6939,
107          6941,
108          6994,
109          7043,
110          7067,
111          7120,
112          7157,
113          7166,
114          10820,
115          28702,
116          77226,
117          79944,
118          90910
119        ],
120        "criteria": "explicit"
121      },
122      "category": {
123        "categories": [],
124        "criteria": "all"
125      },
126      "company_id": 261,
127      "company_store": [],
128      "discount": {
129        "max": -1,
130        "min": 0
131      },
132      "exclude_category": [],
133      "franchise_enabled": true,
134      "image": [
135        "standard"
136      ],
137      "only_verified_products": false,
138      "out_of_stock": false,
139      "price": {
140        "max": -1,
141        "min": 1
142      },
143      "store": {
144        "criteria": "filter",
145        "rules": [
146          {
147            "brands": [
148              11,
149              6939,
150              6941,
151              6994,
152              7043,
153              7067,
154              7120,
155              7157,
156              7166,
157              10820,
158              28702,
159              77226,
160              79944,
161              90910
162            ],
163            "companies": [
164              261
165            ]
166          }
167        ],
168        "stores": []
169      }
170    },
171    "logistics": {
172      "dp_assignment": true,
173      "logistics_by_seller": false,
174      "same_day_delivery": true,
175      "serviceability_check": true
176    },
177    "modified_at": "2024-04-02T07:33:12.335Z",
178    "modified_by": "3c8e77cd3ed632e2ab60ce29",
179    "old_payload": {
180      "inventory": {
181        "brand": {
182          "brands": [],
183          "criteria": "all"
184        },
185        "category": {
186          "categories": [],
187          "criteria": "all"
188        },
189        "company_id": 261,
190        "company_store": [],
191        "discount": {
192          "max": -1,
193          "min": 0
194        },
195        "exclude_category": [],
196        "franchise_enabled": true,
197        "image": [
198          "standard"
199        ],
200        "only_verified_products": false,
201        "out_of_stock": false,
202        "price": {
203          "max": -1,
204          "min": 1
205        },
206        "store": {
207          "criteria": "filter",
208          "rules": [
209            {
210              "brands": [],
211              "companies": [
212                261
213              ]
214            }
215          ],
216          "stores": []
217        }
218      }
219    },
220    "order": {
221      "enabled": true,
222      "force_reassignment": false,
223      "message": ""
224    },
225    "payment": {
226      "anonymous_cod": false,
227      "callback_url": {
228        "app": "",
229        "web": ""
230      },
231      "cod_amount_limit": 49000,
232      "cod_charges": 0,
233      "enabled": true,
234      "methods": {
235        "card": {
236          "enabled": true
237        },
238        "cod": {
239          "enabled": true
240        },
241        "fc": {
242          "enabled": false
243        },
244        "jiopp": {
245          "enabled": false
246        },
247        "jp": {
248          "enabled": false
249        },
250        "juspaypg": {
251          "enabled": false
252        },
253        "nb": {
254          "enabled": true
255        },
256        "pac": {
257          "enabled": false
258        },
259        "payubizpg": {
260          "enabled": false
261        },
262        "payumoneypg": {
263          "enabled": false
264        },
265        "pl": {
266          "enabled": true
267        },
268        "pp": {
269          "enabled": false
270        },
271        "ps": {
272          "enabled": true
273        },
274        "qr": {
275          "enabled": true
276        },
277        "rupifipg": {
278          "enabled": false
279        },
280        "simpl": {
281          "enabled": true
282        },
283        "stripepg": {
284          "enabled": false
285        },
286        "upi": {
287          "enabled": true
288        },
289        "wl": {
290          "enabled": true
291        }
292      },
293      "mode_of_payment": "ECOMM",
294      "payment_selection_lock": {
295        "default_options": "cod",
296        "enabled": false,
297        "payment_identifier": "cod"
298      },
299      "source": "ECOMM",
300      "user_cod_limit": 0
301    },
302    "pii_masking": {
303      "enabled": false
304    },
305    "platforms": [],
306    "reward_points": {
307      "credit": {
308        "enabled": true
309      },
310      "debit": {
311        "auto_apply": false,
312        "enabled": true,
313        "strategy_channel": "REWARDS"
314      }
315    },
316    "tags": []
317  }
318}

Coupon

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

Events
application/coupon/create/v1
# this event is triggered when coupon is created
application/coupon/redeem/v1
# this event is triggered when coupon is redeemed
application/coupon/update/v1
# this event is triggered when coupon is updated

application/coupon/create/v1

this event is triggered when coupon 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
coupon
object
Required
Coupon date consisting data like code and coupon fields.
Properties
action
object
action details of coupon
Properties
action_date
null|string
Required
action date to start coupon actions required in case of txn_mode is not coupon
txn_mode
string
Required
txn mode of the coupon like coupon
author
object
Required
author details of the coupon
Properties
created_by
string
Required
user id by whom the coupon created
modified_by
string
Required
user id by whom the coupon modified
code
string
Required
Coupon unique code
date_meta
object
Required
date details of coupon
Properties
created_on
string
Required
Timestamp on which the coupon was created
modified_on
string
Required
Timestamp on which the coupon was modified
display_meta
object
Required
display details of the coupon
Properties
apply
object
apply message details of the coupon
Properties
subtitle
string
Required
apply message subtitle of the coupon
title
string
Required
title message of the coupon
auto
object
auto apply details of the coupon
Properties
subtitle
string
Required
auto apply subtitle of the coupon
title
string
Required
auto apply title of the coupon
description
string
Description of the coupon
remove
object
Remove details of the coupon
Properties
subtitle
string
Required
remove subtitle of the coupon
title
string
Required
remove title of the coupon
subtitle
string
subtitle of the coupon
title
string
title of the coupon
identifiers
object
Required
condition fields of the coupon
Properties
exclude_brand_id
array of integer
This brand ids will be excluded while applying coupon.
brand_id
array of integer
The brand ids on which coupon will be applied.
item_id
array of integer
The item ids on which coupon will be applied.
company_id
array of integer
The company ids on which coupon will be applied.
article_id
array of integer
The article ids on which coupon will be applied.
store_id
array of integer
The store ids on which coupon will be applied.
collection_id
array of string
Coupon will be applied on mentioned collection ids products.
category_id
array of integer
The category ids on which coupon will be applied.
user_id
array of string
The user ids for which this coupon will be usable.
ownership
object
Required
Ownership details of the coupon
Properties
payable_by
string
Required
user id for who will pay the amount discounted by coupon
payable_category
string
Required
user category for who will pay the amount discounted by coupon
restrictions
object
Required
Restrictions for coupon usage.
Properties
ordering_stores
array of integer
Ordering stores for which coupon is restricted.
platforms
array of string
Required
platforms on which coupon is applicable like web, android, ios
post_order
object
Required
restrictions after the order is placed
Properties
return_allowed
boolean
Required
return is allowed or not on order on which the coupon is applied
cancellation_allowed
boolean
Required
cancellation is allowed or not on order on which the coupon is applied
price_range
object
Required
price range for the coupon
Properties
max
number
Required
max price range of cart.
min
number
Required
min price range of cart.
uses
object
Required
Maximum and remaining usage count for coupon used by user
Properties
maximum
object
Required
Properties
app
number
Total number of times the coupon can be used in the app.
Default Value : -1
total
number
Total number of times per user the coupon can be applied
Default Value : -1
user
number
Maximum number of times per user the coupon can be applied
Default Value : -1
remaining
object
Required
Remaining coupon usage counts.
Properties
app
number
Remaining number of times the coupon can be used in the app.
Default Value : -1
total
number
total number of times the coupon applied and order placed
Default Value : -1
user
number
Uses done by the customer for the coupon
Default Value : -1
rule
array of Undefined Type
Required
Rules to be applied on coupon code i.e payment restriction, cart value, etc.
rule_definition
object
Required
rule defination of the coupon
Properties
applicable_on
string
Required
On which the coupon is applicable like quantity, amount etc.
auto_apply
boolean
Required
If coupon can be auto applied or not.
calculate_on
string
Required
product field on which the coupon calculation happens like esp or mrp
currency_code
string
Required
currency code
is_exact
boolean
Required
scope
array of string
Required
type
string
Required
Display type of the coupon
value_type
string
Required
Exact type of the coupon
state
object
Required
current state of the coupon
Properties
is_archived
boolean
Required
Defines coupon is active or not
is_display
boolean
Required
Defines coupon to be displayed in coupon list
is_public
boolean
Required
Defines if the coupon is public or not
tags
array of Undefined Type
Required
Identify a coupon through tags
type_slug
string
Required
coupon type
validation
object
Required
Coupon validations
Properties
anonymous
boolean
Required
coupon applicable to anonymous user or not
app_id
array of Undefined Type
Required
application/sales channel for which the coupon is created
user_registered_after
null|string
Required
If coupon is for registered user then after which date user is registered on that coupon will apply
validity
object
Required
validity of the coupon
Properties
priority
number
Required
priority of the coupon
_schedule
object
Required
schedule of the coupon
Properties
cron
null|string
Required
cron string of the coupon, if coupon is created periodically
duration
null|number
Required
For how much time coupon can be active
end
null|string
Required
When should coupon should stop applying to user
next_schedule
array of object
Required
Array of Properties
start
null|string
Required
start time of the coupon to be live
end
null|string
Required
end time of the coupon to be live
start
null|string
Required
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when coupon 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        "coupon"
81      ],
82      "properties": {
83        "coupon": {
84          "type": "object",
85          "description": "Coupon date consisting data like code and coupon fields.",
86          "required": [
87            "author",
88            "code",
89            "date_meta",
90            "display_meta",
91            "identifiers",
92            "ownership",
93            "restrictions",
94            "rule",
95            "rule_definition",
96            "state",
97            "tags",
98            "type_slug",
99            "validation",
100            "validity",
101            "_schedule"
102          ],
103          "properties": {
104            "action": {
105              "type": "object",
106              "required": [
107                "action_date",
108                "txn_mode"
109              ],
110              "properties": {
111                "action_date": {
112                  "type": [
113                    "null",
114                    "string"
115                  ],
116                  "description": "action date to start coupon actions required in case of txn_mode is not coupon"
117                },
118                "txn_mode": {
119                  "type": "string",
120                  "description": "txn mode of the coupon like coupon"
121                }
122              },
123              "description": "action details of coupon"
124            },
125            "author": {
126              "type": "object",
127              "required": [
128                "modified_by",
129                "created_by"
130              ],
131              "properties": {
132                "created_by": {
133                  "type": "string",
134                  "description": "user id by whom the coupon created"
135                },
136                "modified_by": {
137                  "type": "string",
138                  "description": "user id by whom the coupon modified"
139                }
140              },
141              "description": "author details of the coupon"
142            },
143            "code": {
144              "type": "string",
145              "description": "Coupon unique code"
146            },
147            "date_meta": {
148              "type": "object",
149              "required": [
150                "created_on",
151                "modified_on"
152              ],
153              "properties": {
154                "created_on": {
155                  "type": "string",
156                  "description": "Timestamp on which the coupon was created"
157                },
158                "modified_on": {
159                  "type": "string",
160                  "description": "Timestamp on which the coupon was modified"
161                }
162              },
163              "description": "date details of coupon"
164            },
165            "display_meta": {
166              "type": "object",
167              "required": [],
168              "properties": {
169                "apply": {
170                  "type": "object",
171                  "required": [
172                    "title",
173                    "subtitle"
174                  ],
175                  "properties": {
176                    "subtitle": {
177                      "type": "string",
178                      "description": "apply message subtitle of the coupon"
179                    },
180                    "title": {
181                      "type": "string",
182                      "description": "title message of the coupon"
183                    }
184                  },
185                  "description": "apply message details of the coupon"
186                },
187                "auto": {
188                  "type": "object",
189                  "required": [
190                    "title",
191                    "subtitle"
192                  ],
193                  "properties": {
194                    "subtitle": {
195                      "type": "string",
196                      "description": "auto apply subtitle of the coupon"
197                    },
198                    "title": {
199                      "type": "string",
200                      "description": "auto apply title of the coupon"
201                    }
202                  },
203                  "description": "auto apply details of the coupon"
204                },
205                "description": {
206                  "type": "string",
207                  "description": "Description of the coupon"
208                },
209                "remove": {
210                  "type": "object",
211                  "required": [
212                    "title",
213                    "subtitle"
214                  ],
215                  "properties": {
216                    "subtitle": {
217                      "type": "string",
218                      "description": "remove subtitle of the coupon"
219                    },
220                    "title": {
221                      "type": "string",
222                      "description": "remove title of the coupon"
223                    }
224                  },
225                  "description": "Remove details of the coupon"
226                },
227                "subtitle": {
228                  "type": "string",
229                  "description": "subtitle of the coupon"
230                },
231                "title": {
232                  "type": "string",
233                  "description": "title of the coupon"
234                }
235              },
236              "description": "display details of the coupon"
237            },
238            "identifiers": {
239              "type": "object",
240              "required": [],
241              "properties": {
242                "exclude_brand_id": {
243                  "type": "array",
244                  "description": "This brand ids will be excluded while applying coupon.",
245                  "items": {
246                    "type": "integer"
247                  }
248                },
249                "brand_id": {
250                  "type": "array",
251                  "description": "The brand ids on which coupon will be applied.",
252                  "items": {
253                    "type": "integer"
254                  }
255                },
256                "item_id": {
257                  "type": "array",
258                  "description": "The item ids on which coupon will be applied.",
259                  "items": {
260                    "type": "integer"
261                  }
262                },
263                "company_id": {
264                  "type": "array",
265                  "description": "The company ids on which coupon will be applied.",
266                  "items": {
267                    "type": "integer"
268                  }
269                },
270                "article_id": {
271                  "type": "array",
272                  "description": "The article ids on which coupon will be applied.",
273                  "items": {
274                    "type": "integer"
275                  }
276                },
277                "store_id": {
278                  "type": "array",
279                  "description": "The store ids on which coupon will be applied.",
280                  "items": {
281                    "type": "integer"
282                  }
283                },
284                "collection_id": {
285                  "type": "array",
286                  "description": "Coupon will be applied on mentioned collection ids products.",
287                  "items": {
288                    "type": "string"
289                  }
290                },
291                "category_id": {
292                  "type": "array",
293                  "description": "The category ids on which coupon will be applied.",
294                  "items": {
295                    "type": "integer"
296                  }
297                },
298                "user_id": {
299                  "type": "array",
300                  "description": "The user ids for which this coupon will be usable.",
301                  "items": {
302                    "type": "string"
303                  }
304                }
305              },
306              "description": "condition fields of the coupon"
307            },
308            "ownership": {
309              "type": "object",
310              "required": [
311                "payable_by",
312                "payable_category"
313              ],
314              "properties": {
315                "payable_by": {
316                  "type": "string",
317                  "description": "user id for who will pay the amount discounted by coupon"
318                },
319                "payable_category": {
320                  "type": "string",
321                  "description": "user category for who will pay the amount discounted by coupon"
322                }
323              },
324              "description": "Ownership details of the coupon"
325            },
326            "restrictions": {
327              "type": "object",
328              "required": [
329                "platforms",
330                "post_order",
331                "price_range",
332                "uses"
333              ],
334              "properties": {
335                "ordering_stores": {
336                  "type": "array",
337                  "items": {
338                    "type": "integer"
339                  },
340                  "description": "Ordering stores for which coupon is restricted."
341                },
342                "platforms": {
343                  "type": "array",
344                  "items": {
345                    "type": "string"
346                  },
347                  "description": "platforms on which coupon is applicable like web, android, ios"
348                },
349                "post_order": {
350                  "type": "object",
351                  "required": [
352                    "cancellation_allowed",
353                    "return_allowed"
354                  ],
355                  "properties": {
356                    "return_allowed": {
357                      "type": "boolean",
358                      "description": "return is allowed or not on order on which the coupon is applied"
359                    },
360                    "cancellation_allowed": {
361                      "type": "boolean",
362                      "description": "cancellation is allowed or not on order on which the coupon is applied"
363                    }
364                  },
365                  "description": "restrictions after the order is placed"
366                },
367                "price_range": {
368                  "type": "object",
369                  "required": [
370                    "max",
371                    "min"
372                  ],
373                  "properties": {
374                    "max": {
375                      "type": "number",
376                      "description": "max price range of cart."
377                    },
378                    "min": {
379                      "type": "number",
380                      "description": "min price range of cart."
381                    }
382                  },
383                  "description": "price range for the coupon"
384                },
385                "uses": {
386                  "type": "object",
387                  "description": "Maximum and remaining usage count for coupon used by user",
388                  "required": [
389                    "maximum",
390                    "remaining"
391                  ],
392                  "properties": {
393                    "maximum": {
394                      "type": "object",
395                      "properties": {
396                        "app": {
397                          "type": "number",
398                          "default": -1,
399                          "description": "Total number of times the coupon can be used in the app."
400                        },
401                        "total": {
402                          "type": "number",
403                          "default": -1,
404                          "description": "Total number of times per user the coupon can be applied"
405                        },
406                        "user": {
407                          "type": "number",
408                          "default": -1,
409                          "description": "Maximum number of times per user the coupon can be applied"
410                        }
411                      }
412                    },
413                    "remaining": {
414                      "type": "object",
415                      "properties": {
416                        "app": {
417                          "type": "number",
418                          "default": -1,
419                          "description": "Remaining number of times the coupon can be used in the app."
420                        },
421                        "total": {
422                          "type": "number",
423                          "default": -1,
424                          "description": "total number of times the coupon applied and order placed"
425                        },
426                        "user": {
427                          "type": "number",
428                          "default": -1,
429                          "description": "Uses done by the customer for the coupon"
430                        }
431                      },
432                      "description": "Remaining coupon usage counts."
433                    }
434                  }
435                }
436              },
437              "description": "Restrictions for coupon usage."
438            },
439            "rule": {
440              "type": "array",
441              "items": [
442                {
443                  "type": "object",
444                  "required": [
445                    "key",
446                    "max",
447                    "min",
448                    "value"
449                  ],
450                  "properties": {
451                    "key": {
452                      "type": "number",
453                      "description": "number of products bought by the customer"
454                    },
455                    "max": {
456                      "type": "number",
457                      "description": "maximum price of products bought by the customer"
458                    },
459                    "min": {
460                      "type": "number",
461                      "description": "minimum price of products bought by the customer"
462                    },
463                    "value": {
464                      "type": "number",
465                      "description": ""
466                    }
467                  }
468                }
469              ],
470              "description": "Rules to be applied on coupon code i.e payment restriction, cart value, etc."
471            },
472            "rule_definition": {
473              "type": "object",
474              "required": [
475                "value_type",
476                "type",
477                "scope",
478                "is_exact",
479                "currency_code",
480                "calculate_on",
481                "auto_apply",
482                "applicable_on"
483              ],
484              "properties": {
485                "applicable_on": {
486                  "type": "string",
487                  "description": "On which the coupon is applicable like quantity, amount etc."
488                },
489                "auto_apply": {
490                  "type": "boolean",
491                  "description": "If coupon can be auto applied or not."
492                },
493                "calculate_on": {
494                  "type": "string",
495                  "description": "product field on which the coupon calculation happens like esp or mrp"
496                },
497                "currency_code": {
498                  "type": "string",
499                  "description": "currency code"
500                },
501                "is_exact": {
502                  "type": "boolean",
503                  "description": ""
504                },
505                "scope": {
506                  "type": "array",
507                  "items": {
508                    "type": "string"
509                  },
510                  "description": ""
511                },
512                "type": {
513                  "type": "string",
514                  "description": "Display type of the coupon"
515                },
516                "value_type": {
517                  "type": "string",
518                  "description": "Exact type of the coupon"
519                }
520              },
521              "description": "rule defination of the coupon"
522            },
523            "state": {
524              "type": "object",
525              "required": [
526                "is_archived",
527                "is_display",
528                "is_public"
529              ],
530              "properties": {
531                "is_archived": {
532                  "type": "boolean",
533                  "description": "Defines coupon is active or not"
534                },
535                "is_display": {
536                  "type": "boolean",
537                  "description": "Defines coupon to be displayed in coupon list"
538                },
539                "is_public": {
540                  "type": "boolean",
541                  "description": "Defines if the coupon is public or not"
542                }
543              },
544              "description": "current state of the coupon"
545            },
546            "tags": {
547              "type": "array",
548              "items": [
549                {
550                  "type": "string"
551                }
552              ],
553              "description": "Identify a coupon through tags"
554            },
555            "type_slug": {
556              "type": "string",
557              "description": "coupon type"
558            },
559            "validation": {
560              "type": "object",
561              "required": [
562                "anonymous",
563                "app_id",
564                "user_registered_after"
565              ],
566              "properties": {
567                "anonymous": {
568                  "type": "boolean",
569                  "description": "coupon applicable to anonymous user or not"
570                },
571                "app_id": {
572                  "type": "array",
573                  "items": [
574                    {
575                      "type": "string"
576                    }
577                  ],
578                  "description": "application/sales channel for which the coupon is created"
579                },
580                "user_registered_after": {
581                  "type": [
582                    "null",
583                    "string"
584                  ],
585                  "description": "If coupon is for registered user then after which date user is registered on that coupon will apply"
586                }
587              },
588              "description": "Coupon validations"
589            },
590            "validity": {
591              "type": "object",
592              "required": [
593                "priority"
594              ],
595              "properties": {
596                "priority": {
597                  "type": "number",
598                  "description": "priority of the coupon"
599                }
600              },
601              "description": "validity of the coupon"
602            },
603            "_schedule": {
604              "type": "object",
605              "required": [
606                "cron",
607                "duration",
608                "end",
609                "next_schedule",
610                "start"
611              ],
612              "properties": {
613                "cron": {
614                  "type": [
615                    "null",
616                    "string"
617                  ],
618                  "description": "cron string of the coupon, if coupon is created periodically"
619                },
620                "duration": {
621                  "type": [
622                    "null",
623                    "number"
624                  ],
625                  "description": "For how much time coupon can be active"
626                },
627                "end": {
628                  "type": [
629                    "null",
630                    "string"
631                  ],
632                  "description": "When should coupon should stop applying to user"
633                },
634                "next_schedule": {
635                  "type": "array",
636                  "items": {
637                    "type": "object",
638                    "required": [
639                      "start",
640                      "end"
641                    ],
642                    "properties": {
643                      "start": {
644                        "type": [
645                          "null",
646                          "string"
647                        ],
648                        "description": "start time of the coupon to be live"
649                      },
650                      "end": {
651                        "type": [
652                          "null",
653                          "string"
654                        ],
655                        "description": "end time of the coupon to be live"
656                      }
657                    },
658                    "description": "next schedule of the coupon"
659                  }
660                },
661                "start": {
662                  "type": [
663                    "null",
664                    "string"
665                  ]
666                }
667              },
668              "description": "schedule of the coupon"
669            }
670          }
671        }
672      }
673    }
674  }
675}
Payload Example
1{
2  "application_id": "65f834e526be5a568ecdb3df",
3  "company_id": 7084,
4  "contains": [
5    "coupon"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1711106635525,
10    "id": "sjOC45ZdeB5xNnfbb++qBE/MmFFxJ8HrT28p9bUyZlw=",
11    "name": "coupon",
12    "trace_id": [
13      "megatron.23901d1a-62bb-4156-b333-d4c1f455ef43"
14    ],
15    "type": "create",
16    "version": "1"
17  },
18  "payload": {
19    "coupon": {
20      "_schedule": {
21        "cron": null,
22        "duration": null,
23        "end": null,
24        "next_schedule": [
25          {
26            "end": null,
27            "start": "2024-03-22T11:23:51.854000+00:00"
28          }
29        ],
30        "start": "2024-03-22T11:23:51.854000+00:00"
31      },
32      "action": {
33        "action_date": null,
34        "txn_mode": "coupon"
35      },
36      "author": {
37        "created_by": "00b72455245370605c35ee80",
38        "modified_by": "00b72455245370605c35ee80"
39      },
40      "code": "wde",
41      "date_meta": {
42        "created_on": "2024-03-22T11:23:55.506888+00:00",
43        "modified_on": "2024-03-22T11:23:55.506888+00:00"
44      },
45      "display_meta": {
46        "apply": {
47          "subtitle": "",
48          "title": "Coupon applied successfully"
49        },
50        "auto": {
51          "subtitle": "",
52          "title": ""
53        },
54        "description": "",
55        "remove": {
56          "subtitle": "",
57          "title": ""
58        },
59        "subtitle": "wdsa",
60        "title": "23"
61      },
62      "identifiers": {
63        "brand_id": [
64          5989
65        ],
66        "user_id": []
67      },
68      "ownership": {
69        "payable_by": "",
70        "payable_category": "seller"
71      },
72      "restrictions": {
73        "ordering_stores": [],
74        "platforms": [
75          "web",
76          "android",
77          "ios"
78        ],
79        "post_order": {
80          "cancellation_allowed": true,
81          "return_allowed": true
82        },
83        "price_range": {
84          "max": -1,
85          "min": -1
86        },
87        "uses": {
88          "maximum": {
89            "app": -1,
90            "total": -1,
91            "user": -1
92          },
93          "remaining": {
94            "app": -1,
95            "total": -1,
96            "user": -1
97          }
98        }
99      },
100      "rule": [
101        {
102          "key": 1,
103          "max": 3,
104          "min": 2,
105          "value": 3
106        }
107      ],
108      "rule_definition": {
109        "applicable_on": "quantity",
110        "auto_apply": false,
111        "calculate_on": "esp",
112        "currency_code": "INR",
113        "is_exact": true,
114        "scope": [
115          "brand_id"
116        ],
117        "type": "bundle",
118        "value_type": "percentage"
119      },
120      "state": {
121        "is_archived": false,
122        "is_display": true,
123        "is_public": true
124      },
125      "tags": [
126        "platform"
127      ],
128      "type_slug": "bundle_quantity_percentage",
129      "validation": {
130        "anonymous": true,
131        "app_id": [
132          "65f834e526be5a568ecdb3df"
133        ],
134        "user_registered_after": null
135      },
136      "validity": {
137        "priority": 0
138      }
139    }
140  }
141}

application/coupon/redeem/v1

this event is triggered when coupon is redeemed

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
coupon
object
Required
Coupon key contains coupon data and coupon value.
Properties
coupon
object
Required
Coupon date consisting data like code and coupon fields.
Properties
_id
string
Required
Unique identification for the coupon
code
string
Required
Coupon unique code
rule
array of object
Required
Rules to be applied on coupon code i.e payment restriction, cart value, etc.
tags
array of string
Identify a coupon through tags
state
object
Required
current state of the coupon
action
object
Required
action details of coupon
author
object
Required
author details of the coupon
Properties
created_by
string
Required
user id by whom the coupon created
modified_by
string
Required
user id by whom the coupon modified
_source
object
source of the coupon
validity
object
Required
validity of the coupon
_schedule
object
Required
schedule of the coupon
date_meta
object
Required
date details of coupon
Properties
created_on
string
Required
Timestamp on which the coupon was created
modified_on
string
Required
Timestamp on which the coupon was modified
ownership
object
Required
Ownership details of the coupon
Properties
payable_by
string
Required
user id for who will pay the amount discounted by coupon
payable_category
string
Required
user category for who will pay the amount discounted by coupon
type_slug
string
Required
coupon type
validation
object
Required
Coupon validations
Properties
anonymous
boolean
Required
coupon applicable to anonymous user or not
app_id
array of Undefined Type
Required
application/sales channel for which the coupon is created
user_registered_after
null|string
Required
If coupon is for registered user then after which date user is registered on that coupon will apply
identifiers
object
Required
condition fields of the coupon
Properties
exclude_brand_id
array of integer
This brand ids will be excluded while applying coupon.
brand_id
array of integer
The brand ids on which coupon will be applied.
item_id
array of integer
The item ids on which coupon will be applied.
company_id
array of integer
The company ids on which coupon will be applied.
article_id
array of integer
The article ids on which coupon will be applied.
store_id
array of integer
The store ids on which coupon will be applied.
collection_id
array of string
Coupon will be applied on mentioned collection ids products.
category_id
array of integer
The category ids on which coupon will be applied.
user_id
array of string
The user ids for which this coupon will be usable.
display_meta
object
Required
display details of the coupon
restrictions
object
Required
Restrictions for coupon usage
rule_definition
object
Required
rule defination of the coupon
Properties
applicable_on
string
Required
On which the coupon is applicable like quantity, amount etc.
auto_apply
boolean
Required
If coupon can be auto applied or not.
calculate_on
string
Required
product field on which the coupon calculation happens like esp or mrp
currency_code
string
Required
currency code
is_exact
boolean
Required
When set as true then qty cap for coupon being applied will be enforced otherwise no cap for qty.
scope
array of string
Required
Scope for coupon applicability like brand
type
string
Required
Display type of the coupon
value_type
string
Required
Exact type of the coupon
cart_id
string
Required
cart id on which the coupon is redeemed
coupon_value
number
Required
coupon value applied on cart
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when coupon is redeemed.",
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        "coupon"
81      ],
82      "properties": {
83        "coupon": {
84          "type": "object",
85          "description": "Coupon key contains coupon data and coupon value.",
86          "required": [
87            "cart_id",
88            "coupon_value",
89            "coupon"
90          ],
91          "properties": {
92            "coupon": {
93              "type": "object",
94              "description": "Coupon date consisting data like code and coupon fields.",
95              "required": [
96                "code",
97                "_id",
98                "_schedule",
99                "type_slug",
100                "rule_definition",
101                "date_meta",
102                "state",
103                "validation",
104                "action",
105                "restrictions",
106                "validity",
107                "display_meta",
108                "ownership",
109                "identifiers",
110                "author",
111                "rule"
112              ],
113              "properties": {
114                "_id": {
115                  "type": "string",
116                  "description": "Unique identification for the coupon"
117                },
118                "code": {
119                  "type": "string",
120                  "description": "Coupon unique code"
121                },
122                "rule": {
123                  "type": "array",
124                  "items": {
125                    "type": "object"
126                  },
127                  "description": "Rules to be applied on coupon code i.e payment restriction, cart value, etc."
128                },
129                "tags": {
130                  "type": "array",
131                  "items": {
132                    "type": "string"
133                  },
134                  "description": "Identify a coupon through tags"
135                },
136                "state": {
137                  "type": "object",
138                  "description": "current state of the coupon"
139                },
140                "action": {
141                  "type": "object",
142                  "description": "action details of coupon"
143                },
144                "author": {
145                  "type": "object",
146                  "required": [
147                    "modified_by",
148                    "created_by"
149                  ],
150                  "properties": {
151                    "created_by": {
152                      "type": "string",
153                      "description": "user id by whom the coupon created"
154                    },
155                    "modified_by": {
156                      "type": "string",
157                      "description": "user id by whom the coupon modified"
158                    }
159                  },
160                  "description": "author details of the coupon"
161                },
162                "_source": {
163                  "type": "object",
164                  "description": "source of the coupon"
165                },
166                "validity": {
167                  "type": "object",
168                  "description": "validity of the coupon"
169                },
170                "_schedule": {
171                  "type": "object",
172                  "description": "schedule of the coupon"
173                },
174                "date_meta": {
175                  "type": "object",
176                  "required": [
177                    "created_on",
178                    "modified_on"
179                  ],
180                  "properties": {
181                    "created_on": {
182                      "type": "string",
183                      "description": "Timestamp on which the coupon was created"
184                    },
185                    "modified_on": {
186                      "type": "string",
187                      "description": "Timestamp on which the coupon was modified"
188                    }
189                  },
190                  "description": "date details of coupon"
191                },
192                "ownership": {
193                  "type": "object",
194                  "required": [
195                    "payable_by",
196                    "payable_category"
197                  ],
198                  "properties": {
199                    "payable_by": {
200                      "type": "string",
201                      "description": "user id for who will pay the amount discounted by coupon"
202                    },
203                    "payable_category": {
204                      "type": "string",
205                      "description": "user category for who will pay the amount discounted by coupon"
206                    }
207                  },
208                  "description": "Ownership details of the coupon"
209                },
210                "type_slug": {
211                  "type": "string",
212                  "description": "coupon type"
213                },
214                "validation": {
215                  "type": "object",
216                  "required": [
217                    "anonymous",
218                    "app_id",
219                    "user_registered_after"
220                  ],
221                  "properties": {
222                    "anonymous": {
223                      "type": "boolean",
224                      "description": "coupon applicable to anonymous user or not"
225                    },
226                    "app_id": {
227                      "type": "array",
228                      "items": [
229                        {
230                          "type": "string"
231                        }
232                      ],
233                      "description": "application/sales channel for which the coupon is created"
234                    },
235                    "user_registered_after": {
236                      "type": [
237                        "null",
238                        "string"
239                      ],
240                      "description": "If coupon is for registered user then after which date user is registered on that coupon will apply"
241                    }
242                  },
243                  "description": "Coupon validations"
244                },
245                "identifiers": {
246                  "type": "object",
247                  "required": [],
248                  "properties": {
249                    "exclude_brand_id": {
250                      "type": "array",
251                      "description": "This brand ids will be excluded while applying coupon.",
252                      "items": {
253                        "type": "integer"
254                      }
255                    },
256                    "brand_id": {
257                      "type": "array",
258                      "description": "The brand ids on which coupon will be applied.",
259                      "items": {
260                        "type": "integer"
261                      }
262                    },
263                    "item_id": {
264                      "type": "array",
265                      "description": "The item ids on which coupon will be applied.",
266                      "items": {
267                        "type": "integer"
268                      }
269                    },
270                    "company_id": {
271                      "type": "array",
272                      "description": "The company ids on which coupon will be applied.",
273                      "items": {
274                        "type": "integer"
275                      }
276                    },
277                    "article_id": {
278                      "type": "array",
279                      "description": "The article ids on which coupon will be applied.",
280                      "items": {
281                        "type": "integer"
282                      }
283                    },
284                    "store_id": {
285                      "type": "array",
286                      "description": "The store ids on which coupon will be applied.",
287                      "items": {
288                        "type": "integer"
289                      }
290                    },
291                    "collection_id": {
292                      "type": "array",
293                      "description": "Coupon will be applied on mentioned collection ids products.",
294                      "items": {
295                        "type": "string"
296                      }
297                    },
298                    "category_id": {
299                      "type": "array",
300                      "description": "The category ids on which coupon will be applied.",
301                      "items": {
302                        "type": "integer"
303                      }
304                    },
305                    "user_id": {
306                      "type": "array",
307                      "description": "The user ids for which this coupon will be usable.",
308                      "items": {
309                        "type": "string"
310                      }
311                    }
312                  },
313                  "description": "condition fields of the coupon"
314                },
315                "display_meta": {
316                  "type": "object",
317                  "description": "display details of the coupon"
318                },
319                "restrictions": {
320                  "type": "object",
321                  "description": "Restrictions for coupon usage"
322                },
323                "rule_definition": {
324                  "type": "object",
325                  "required": [
326                    "value_type",
327                    "type",
328                    "scope",
329                    "is_exact",
330                    "currency_code",
331                    "calculate_on",
332                    "auto_apply",
333                    "applicable_on"
334                  ],
335                  "properties": {
336                    "applicable_on": {
337                      "type": "string",
338                      "description": "On which the coupon is applicable like quantity, amount etc."
339                    },
340                    "auto_apply": {
341                      "type": "boolean",
342                      "description": "If coupon can be auto applied or not."
343                    },
344                    "calculate_on": {
345                      "type": "string",
346                      "description": "product field on which the coupon calculation happens like esp or mrp"
347                    },
348                    "currency_code": {
349                      "type": "string",
350                      "description": "currency code"
351                    },
352                    "is_exact": {
353                      "type": "boolean",
354                      "description": "When set as true then qty cap for coupon being applied will be enforced otherwise no cap for qty."
355                    },
356                    "scope": {
357                      "type": "array",
358                      "items": {
359                        "type": "string"
360                      },
361                      "description": "Scope for coupon applicability like brand"
362                    },
363                    "type": {
364                      "type": "string",
365                      "description": "Display type of the coupon"
366                    },
367                    "value_type": {
368                      "type": "string",
369                      "description": "Exact type of the coupon"
370                    }
371                  },
372                  "description": "rule defination of the coupon"
373                }
374              }
375            },
376            "cart_id": {
377              "type": "string",
378              "description": "cart id on which the coupon is redeemed"
379            },
380            "coupon_value": {
381              "type": "number",
382              "description": "coupon value applied on cart"
383            }
384          }
385        }
386      }
387    }
388  }
389}
Payload Example
1{
2  "payload": {
3    "coupon": {
4      "coupon": {
5        "ownership": {
6          "payable_by": "",
7          "payable_category": "seller"
8        },
9        "author": {
10          "modified_by": "b0057be8702ac9b07834f8b6",
11          "created_by": "da036ff02652aaa554b79d69"
12        },
13        "validation": {
14          "anonymous": false,
15          "user_registered_after": null,
16          "app_id": [
17            "000000000000000000000001"
18          ]
19        },
20        "action": {
21          "txn_mode": "coupon",
22          "action_date": null
23        },
24        "_schedule": {
25          "next_schedule": [
26            {
27              "start": "2024-01-18 12:22:03.138000",
28              "end": null
29            }
30          ],
31          "start": "2024-01-18T12:22:03.138000+00:00",
32          "end": null,
33          "cron": null,
34          "duration": null
35        },
36        "rule": [
37          {
38            "min": 10,
39            "value": 11999,
40            "max": 0,
41            "key": 1
42          }
43        ],
44        "state": {
45          "is_display": true,
46          "is_archived": false,
47          "is_public": true
48        },
49        "display_meta": {
50          "apply": {
51            "subtitle": "",
52            "title": "Coupon applied successfully"
53          },
54          "description": "",
55          "subtitle": "Testing1",
56          "remove": {
57            "subtitle": "",
58            "title": ""
59          },
60          "title": "Testing1",
61          "auto": {
62            "subtitle": "",
63            "title": ""
64          }
65        },
66        "type_slug": "absolute_quantity_absolute",
67        "rule_definition": {
68          "currency_code": "INR",
69          "value_type": "absolute",
70          "type": "absolute",
71          "auto_apply": false,
72          "is_exact": false,
73          "applicable_on": "quantity",
74          "scope": [],
75          "calculate_on": "esp"
76        },
77        "tags": [
78          "platform"
79        ],
80        "identifiers": {
81          "user_id": []
82        },
83        "_id": "65a917eb5fc8c9b0eac889af",
84        "_source": {
85          "type": "extension",
86          "id": "64b00c93c733f68edef8157b"
87        },
88        "validity": {
89          "priority": 0
90        },
91        "code": "testing1",
92        "restrictions": {
93          "ordering_stores": [],
94          "uses": {
95            "remaining": {
96              "app": -1,
97              "user": -1,
98              "total": -1
99            },
100            "maximum": {
101              "app": -1,
102              "user": -1,
103              "total": -1
104            }
105          },
106          "post_order": {
107            "return_allowed": false,
108            "cancellation_allowed": false
109          },
110          "price_range": {
111            "max": -1,
112            "min": -1
113          },
114          "payments": {
115            "wl": {
116              "networks": [],
117              "uses": {
118                "max": -1
119              },
120              "types": [],
121              "codes": []
122            },
123            "nb": {
124              "networks": [],
125              "uses": {
126                "max": -1
127              },
128              "types": [],
129              "codes": []
130            },
131            "card": {
132              "networks": [],
133              "uses": {
134                "max": -1
135              },
136              "types": [],
137              "codes": []
138            },
139            "qr": {
140              "networks": [],
141              "uses": {
142                "max": -1
143              },
144              "types": [],
145              "codes": []
146            },
147            "cod": {
148              "networks": [],
149              "uses": {
150                "max": -1
151              },
152              "types": [],
153              "codes": []
154            },
155            "pay from potlee": {
156              "networks": [],
157              "uses": {
158                "max": -1
159              },
160              "types": [],
161              "codes": []
162            },
163            "icici bank paylater": {
164              "networks": [],
165              "uses": {
166                "max": -1
167              },
168              "types": [],
169              "codes": []
170            },
171            "flexipay by hdfc bank": {
172              "networks": [],
173              "uses": {
174                "max": -1
175              },
176              "types": [],
177              "codes": []
178            },
179            "simpl": {
180              "networks": [],
181              "uses": {
182                "max": -1
183              },
184              "types": [],
185              "codes": []
186            },
187            "rupifipg": {
188              "networks": [],
189              "uses": {
190                "max": -1
191              },
192              "types": [],
193              "codes": []
194            },
195            "cardless_emi": {
196              "networks": [],
197              "uses": {
198                "max": -1
199              },
200              "types": [],
201              "codes": []
202            },
203            "cas": {
204              "networks": [],
205              "uses": {
206                "max": -1
207              },
208              "types": [],
209              "codes": []
210            },
211            "csas": {
212              "networks": [],
213              "uses": {
214                "max": -1
215              },
216              "types": [],
217              "codes": []
218            }
219          },
220          "platforms": [
221            "web",
222            "android",
223            "ios"
224          ]
225        },
226        "date_meta": {
227          "created_on": "2024-01-18T12:22:03.307000+00:00",
228          "modified_on": "2024-02-07T07:51:09.917000+00:00"
229        }
230      },
231      "coupon_value": 11999,
232      "cart_id": "985404"
233    }
234  },
235  "contains": [
236    "coupon"
237  ],
238  "event": {
239    "id": "testID",
240    "name": "coupon",
241    "type": "redeem",
242    "version": "1",
243    "category": "application",
244    "trace_id": [
245      "megatron.c1d94419-57d6-47ef-a5d5-b8829e8b4304"
246    ],
247    "created_timestamp": 1712238862735
248  },
249  "company_id": 1,
250  "application_id": "000000000000000000000001"
251}

application/coupon/update/v1

this event is triggered when coupon 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
coupon
object
Required
Properties
action
object
action details of coupon
Properties
action_date
null|string
Required
action date to start coupon actions required in case of txn_mode is not coupon
txn_mode
string
Required
txn mode of the coupon like coupon
author
object
Required
author details of the coupon
Properties
created_by
string
Required
user id by whom the coupon created
modified_by
string
Required
user id by whom the coupon modified
code
string
Required
Coupon unique code
date_meta
object
Required
date details of coupon
Properties
created_on
string
Required
Timestamp on which the coupon was created
modified_on
string
Required
Timestamp on which the coupon was modified
display_meta
object
Required
display details of the coupon
Properties
apply
object
apply message details of the coupon
Properties
subtitle
string
Required
apply message subtitle of the coupon
title
string
Required
title message of the coupon
auto
object
auto apply details of the coupon
Properties
subtitle
string
Required
auto apply subtitle of the coupon
title
string
Required
auto apply title of the coupon
description
string
Description of the coupon
remove
object
Remove details of the coupon
Properties
subtitle
string
Required
remove subtitle of the coupon
title
string
Required
remove title of the coupon
subtitle
string
subtitle of the coupon
title
string
title of the coupon
identifiers
object
Required
condition fields of the coupon
Properties
exclude_brand_id
array of integer
This brand ids will be excluded while applying coupon.
brand_id
array of integer
The brand ids on which coupon will be applied.
item_id
array of integer
The item ids on which coupon will be applied.
company_id
array of integer
The company ids on which coupon will be applied.
article_id
array of integer
The article ids on which coupon will be applied.
store_id
array of integer
The store ids on which coupon will be applied.
collection_id
array of string
Coupon will be applied on mentioned collection ids products.
category_id
array of integer
The category ids on which coupon will be applied.
user_id
array of string
The user ids for which this coupon will be usable.
ownership
object
Required
Ownership details of the coupon
Properties
payable_by
string
Required
user id for who will pay the amount discounted by coupon
payable_category
string
Required
user category for who will pay the amount discounted by coupon
restrictions
object
Required
Restrictions for coupon usage
Properties
ordering_stores
array of integer
Ordering stores for which coupon is restricted.
platforms
array of string
Required
platforms on which coupon is applicable like web, android, ios
post_order
object
Required
restrictions after the order is placed
Properties
return_allowed
boolean
Required
return is allowed or not on order on which the coupon is applied
cancellation_allowed
boolean
Required
cancellation is allowed or not on order on which the coupon is applied
price_range
object
Required
price range for the coupon
Properties
max
number
Required
max price range of cart.
min
number
Required
min price range of cart.
uses
object
Required
Maximum and remaining Usage count for coupon used by user.
Properties
maximum
object
Required
Properties
app
number
Total number of count for coupon usages in app
Default Value : -1
total
number
Total number of times per user the coupon can be applied
Default Value : -1
user
number
Maximum number of times per user the coupon can be applied
Default Value : -1
remaining
object
Required
Properties
app
number
Remained number of count for coupon usages in app
Default Value : -1
total
number
total number of times the coupon applied and order placed
Default Value : -1
user
number
Uses done by the customer for the coupon
Default Value : -1
rule
array of Undefined Type
Required
Rules to be applied on coupon code i.e payment restriction, cart value, etc.
rule_definition
object
Required
rule defination of the coupon
Properties
applicable_on
string
Required
On which the coupon is applicable like quantity, amount etc.
auto_apply
boolean
Required
If coupon can be auto applied or not.
calculate_on
string
Required
product field on which the coupon calculation happens like esp or mrp
currency_code
string
Required
currency code
is_exact
boolean
Required
scope
array of string
Required
type
string
Required
Display type of the coupon
value_type
string
Required
Exact type of the coupon
state
object
Required
current state of the coupon
Properties
is_archived
boolean
Required
Defines coupon is active or not
is_display
boolean
Required
Defines coupon to be displayed in coupon list
is_public
boolean
Required
Defines if the coupon is public or not
tags
array of Undefined Type
Required
Identify a coupon through tags
type_slug
string
Required
coupon type
validation
object
Required
Coupon validations
Properties
anonymous
boolean
Required
coupon applicable to anonymous user or not
app_id
array of Undefined Type
Required
application/sales channel for which the coupon is created
user_registered_after
null|string
Required
If coupon is for registered user then after which date user is registered on that coupon will apply
validity
object
Required
validity of the coupon
Properties
priority
number
Required
priority of the coupon
_schedule
object
Required
schedule of the coupon
Properties
cron
null|string
Required
cron string of the coupon, if coupon is created periodically
duration
null|number
Required
For how much time coupon can be active
end
null|string
Required
When should coupon should stop applying to user
next_schedule
array of object
Required
Array of Properties
start
null|string
Required
start time of the coupon to be live
end
null|string
Required
end time of the coupon to be live
start
null|string
Required
Payload Schema JSON
1{
2  "type": "object",
3  "description": "This event is triggered when coupon 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        "coupon"
81      ],
82      "properties": {
83        "coupon": {
84          "type": "object",
85          "required": [
86            "author",
87            "code",
88            "date_meta",
89            "display_meta",
90            "identifiers",
91            "ownership",
92            "restrictions",
93            "rule",
94            "rule_definition",
95            "state",
96            "tags",
97            "type_slug",
98            "validation",
99            "validity",
100            "_schedule"
101          ],
102          "properties": {
103            "action": {
104              "type": "object",
105              "required": [
106                "action_date",
107                "txn_mode"
108              ],
109              "properties": {
110                "action_date": {
111                  "type": [
112                    "null",
113                    "string"
114                  ],
115                  "description": "action date to start coupon actions required in case of txn_mode is not coupon"
116                },
117                "txn_mode": {
118                  "type": "string",
119                  "description": "txn mode of the coupon like coupon"
120                }
121              },
122              "description": "action details of coupon"
123            },
124            "author": {
125              "type": "object",
126              "required": [
127                "modified_by",
128                "created_by"
129              ],
130              "properties": {
131                "created_by": {
132                  "type": "string",
133                  "description": "user id by whom the coupon created"
134                },
135                "modified_by": {
136                  "type": "string",
137                  "description": "user id by whom the coupon modified"
138                }
139              },
140              "description": "author details of the coupon"
141            },
142            "code": {
143              "type": "string",
144              "description": "Coupon unique code"
145            },
146            "date_meta": {
147              "type": "object",
148              "required": [
149                "created_on",
150                "modified_on"
151              ],
152              "properties": {
153                "created_on": {
154                  "type": "string",
155                  "description": "Timestamp on which the coupon was created"
156                },
157                "modified_on": {
158                  "type": "string",
159                  "description": "Timestamp on which the coupon was modified"
160                }
161              },
162              "description": "date details of coupon"
163            },
164            "display_meta": {
165              "type": "object",
166              "required": [],
167              "properties": {
168                "apply": {
169                  "type": "object",
170                  "required": [
171                    "title",
172                    "subtitle"
173                  ],
174                  "properties": {
175                    "subtitle": {
176                      "type": "string",
177                      "description": "apply message subtitle of the coupon"
178                    },
179                    "title": {
180                      "type": "string",
181                      "description": "title message of the coupon"
182                    }
183                  },
184                  "description": "apply message details of the coupon"
185                },
186                "auto": {
187                  "type": "object",
188                  "required": [
189                    "title",
190                    "subtitle"
191                  ],
192                  "properties": {
193                    "subtitle": {
194                      "type": "string",
195                      "description": "auto apply subtitle of the coupon"
196                    },
197                    "title": {
198                      "type": "string",
199                      "description": "auto apply title of the coupon"
200                    }
201                  },
202                  "description": "auto apply details of the coupon"
203                },
204                "description": {
205                  "type": "string",
206                  "description": "Description of the coupon"
207                },
208                "remove": {
209                  "type": "object",
210                  "required": [
211                    "title",
212                    "subtitle"
213                  ],
214                  "properties": {
215                    "subtitle": {
216                      "type": "string",
217                      "description": "remove subtitle of the coupon"
218                    },
219                    "title": {
220                      "type": "string",
221                      "description": "remove title of the coupon"
222                    }
223                  },
224                  "description": "Remove details of the coupon"
225                },
226                "subtitle": {
227                  "type": "string",
228                  "description": "subtitle of the coupon"
229                },
230                "title": {
231                  "type": "string",
232                  "description": "title of the coupon"
233                }
234              },
235              "description": "display details of the coupon"
236            },
237            "identifiers": {
238              "type": "object",
239              "required": [],
240              "properties": {
241                "exclude_brand_id": {
242                  "type": "array",
243                  "description": "This brand ids will be excluded while applying coupon.",
244                  "items": {
245                    "type": "integer"
246                  }
247                },
248                "brand_id": {
249                  "type": "array",
250                  "description": "The brand ids on which coupon will be applied.",
251                  "items": {
252                    "type": "integer"
253                  }
254                },
255                "item_id": {
256                  "type": "array",
257                  "description": "The item ids on which coupon will be applied.",
258                  "items": {
259                    "type": "integer"
260                  }
261                },
262                "company_id": {
263                  "type": "array",
264                  "description": "The company ids on which coupon will be applied.",
265                  "items": {
266                    "type": "integer"
267                  }
268                },
269                "article_id": {
270                  "type": "array",
271                  "description": "The article ids on which coupon will be applied.",
272                  "items": {
273                    "type": "integer"
274                  }
275                },
276                "store_id": {
277                  "type": "array",
278                  "description": "The store ids on which coupon will be applied.",
279                  "items": {
280                    "type": "integer"
281                  }
282                },
283                "collection_id": {
284                  "type": "array",
285                  "description": "Coupon will be applied on mentioned collection ids products.",
286                  "items": {
287                    "type": "string"
288                  }
289                },
290                "category_id": {
291                  "type": "array",
292                  "description": "The category ids on which coupon will be applied.",
293                  "items": {
294                    "type": "integer"
295                  }
296                },
297                "user_id": {
298                  "type": "array",
299                  "description": "The user ids for which this coupon will be usable.",
300                  "items": {
301                    "type": "string"
302                  }
303                }
304              },
305              "description": "condition fields of the coupon"
306            },
307            "ownership": {
308              "type": "object",
309              "required": [
310                "payable_by",
311                "payable_category"
312              ],
313              "properties": {
314                "payable_by": {
315                  "type": "string",
316                  "description": "user id for who will pay the amount discounted by coupon"
317                },
318                "payable_category": {
319                  "type": "string",
320                  "description": "user category for who will pay the amount discounted by coupon"
321                }
322              },
323              "description": "Ownership details of the coupon"
324            },
325            "restrictions": {
326              "type": "object",
327              "required": [
328                "platforms",
329                "post_order",
330                "price_range",
331                "uses"
332              ],
333              "properties": {
334                "ordering_stores": {
335                  "type": "array",
336                  "items": {
337                    "type": "integer"
338                  },
339                  "description": "Ordering stores for which coupon is restricted."
340                },
341                "platforms": {
342                  "type": "array",
343                  "items": {
344                    "type": "string"
345                  },
346                  "description": "platforms on which coupon is applicable like web, android, ios"
347                },
348                "post_order": {
349                  "type": "object",
350                  "required": [
351                    "cancellation_allowed",
352                    "return_allowed"
353                  ],
354                  "properties": {
355                    "return_allowed": {
356                      "type": "boolean",
357                      "description": "return is allowed or not on order on which the coupon is applied"
358                    },
359                    "cancellation_allowed": {
360                      "type": "boolean",
361                      "description": "cancellation is allowed or not on order on which the coupon is applied"
362                    }
363                  },
364                  "description": "restrictions after the order is placed"
365                },
366                "price_range": {
367                  "type": "object",
368                  "required": [
369                    "max",
370                    "min"
371                  ],
372                  "properties": {
373                    "max": {
374                      "type": "number",
375                      "description": "max price range of cart."
376                    },
377                    "min": {
378                      "type": "number",
379                      "description": "min price range of cart."
380                    }
381                  },
382                  "description": "price range for the coupon"
383                },
384                "uses": {
385                  "type": "object",
386                  "description": "Maximum and remaining Usage count for coupon used by user.",
387                  "required": [
388                    "maximum",
389                    "remaining"
390                  ],
391                  "properties": {
392                    "maximum": {
393                      "type": "object",
394                      "properties": {
395                        "app": {
396                          "type": "number",
397                          "default": -1,
398                          "description": "Total number of count for coupon usages in app"
399                        },
400                        "total": {
401                          "type": "number",
402                          "default": -1,
403                          "description": "Total number of times per user the coupon can be applied"
404                        },
405                        "user": {
406                          "type": "number",
407                          "default": -1,
408                          "description": "Maximum number of times per user the coupon can be applied"
409                        }
410                      }
411                    },
412                    "remaining": {
413                      "type": "object",
414                      "properties": {
415                        "app": {
416                          "type": "number",
417                          "default": -1,
418                          "description": "Remained number of count for coupon usages in app"
419                        },
420                        "total": {
421                          "type": "number",
422                          "default": -1,
423                          "description": "total number of times the coupon applied and order placed"
424                        },
425                        "user": {
426                          "type": "number",
427                          "default": -1,
428                          "description": "Uses done by the customer for the coupon"
429                        }
430                      }
431                    }
432                  }
433                }
434              },
435              "description": "Restrictions for coupon usage"
436            },
437            "rule": {
438              "type": "array",
439              "items": [
440                {
441                  "type": "object",
442                  "required": [
443                    "key",
444                    "max",
445                    "min"
446                  ],
447                  "properties": {
448                    "key": {
449                      "type": "number",
450                      "description": "number of products bought by the customer"
451                    },
452                    "max": {
453                      "type": "number",
454                      "description": "maximum price of products bought by the customer"
455                    },
456                    "min": {
457                      "type": "number",
458                      "description": "minimum price of products bought by the customer"
459                    },
460                    "value": {
461                      "type": "number",
462                      "description": ""
463                    }
464                  }
465                }
466              ],
467              "description": "Rules to be applied on coupon code i.e payment restriction, cart value, etc."
468            },
469            "rule_definition": {
470              "type": "object",
471              "required": [
472                "value_type",
473                "type",
474                "scope",
475                "is_exact",
476                "currency_code",
477                "calculate_on",
478                "auto_apply",
479                "applicable_on"
480              ],
481              "properties": {
482                "applicable_on": {
483                  "type": "string",
484                  "description": "On which the coupon is applicable like quantity, amount etc."
485                },
486                "auto_apply": {
487                  "type": "boolean",
488                  "description": "If coupon can be auto applied or not."
489                },
490                "calculate_on": {
491                  "type": "string",
492                  "description": "product field on which the coupon calculation happens like esp or mrp"
493                },
494                "currency_code": {
495                  "type": "string",
496                  "description": "currency code"
497                },
498                "is_exact": {
499                  "type": "boolean",
500                  "description": ""
501                },
502                "scope": {
503                  "type": "array",
504                  "items": {
505                    "type": "string"
506                  },
507                  "description": ""
508                },
509                "type": {
510                  "type": "string",
511                  "description": "Display type of the coupon"
512                },
513                "value_type": {
514                  "type": "string",
515                  "description": "Exact type of the coupon"
516                }
517              },
518              "description": "rule defination of the coupon"
519            },
520            "state": {
521              "type": "object",
522              "required": [
523                "is_archived",
524                "is_display",
525                "is_public"
526              ],
527              "properties": {
528                "is_archived": {
529                  "type": "boolean",
530                  "description": "Defines coupon is active or not"
531                },
532                "is_display": {
533                  "type": "boolean",
534                  "description": "Defines coupon to be displayed in coupon list"
535                },
536                "is_public": {
537                  "type": "boolean",
538                  "description": "Defines if the coupon is public or not"
539                }
540              },
541              "description": "current state of the coupon"
542            },
543            "tags": {
544              "type": "array",
545              "items": [
546                {
547                  "type": "string"
548                }
549              ],
550              "description": "Identify a coupon through tags"
551            },
552            "type_slug": {
553              "type": "string",
554              "description": "coupon type"
555            },
556            "validation": {
557              "type": "object",
558              "required": [
559                "anonymous",
560                "app_id",
561                "user_registered_after"
562              ],
563              "properties": {
564                "anonymous": {
565                  "type": "boolean",
566                  "description": "coupon applicable to anonymous user or not"
567                },
568                "app_id": {
569                  "type": "array",
570                  "items": [
571                    {
572                      "type": "string"
573                    }
574                  ],
575                  "description": "application/sales channel for which the coupon is created"
576                },
577                "user_registered_after": {
578                  "type": [
579                    "null",
580                    "string"
581                  ],
582                  "description": "If coupon is for registered user then after which date user is registered on that coupon will apply"
583                }
584              },
585              "description": "Coupon validations"
586            },
587            "validity": {
588              "type": "object",
589              "required": [
590                "priority"
591              ],
592              "properties": {
593                "priority": {
594                  "type": "number",
595                  "description": "priority of the coupon"
596                }
597              },
598              "description": "validity of the coupon"
599            },
600            "_schedule": {
601              "type": "object",
602              "required": [
603                "cron",
604                "duration",
605                "end",
606                "next_schedule",
607                "start"
608              ],
609              "properties": {
610                "cron": {
611                  "type": [
612                    "null",
613                    "string"
614                  ],
615                  "description": "cron string of the coupon, if coupon is created periodically"
616                },
617                "duration": {
618                  "type": [
619                    "null",
620                    "number"
621                  ],
622                  "description": "For how much time coupon can be active"
623                },
624                "end": {
625                  "type": [
626                    "null",
627                    "string"
628                  ],
629                  "description": "When should coupon should stop applying to user"
630                },
631                "next_schedule": {
632                  "type": "array",
633                  "items": {
634                    "type": "object",
635                    "required": [
636                      "start",
637                      "end"
638                    ],
639                    "properties": {
640                      "start": {
641                        "type": [
642                          "null",
643                          "string"
644                        ],
645                        "description": "start time of the coupon to be live"
646                      },
647                      "end": {
648                        "type": [
649                          "null",
650                          "string"
651                        ],
652                        "description": "end time of the coupon to be live"
653                      }
654                    },
655                    "description": "next schedule of the coupon"
656                  }
657                },
658                "start": {
659                  "type": [
660                    "null",
661                    "string"
662                  ]
663                }
664              },
665              "description": "schedule of the coupon"
666            }
667          }
668        }
669      }
670    }
671  }
672}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.046425af-2190-4026-aa80-3f589ca416e2"
5    ],
6    "name": "coupon",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711614375492,
10    "id": "UDu6EWAkiYjeUbl5KHLYXgdoBBVHKV69QnRpZWXpuIg=",
11    "category": "application"
12  },
13  "company_id": 327,
14  "application_id": "60744d605bdf7f6a00a86ff9",
15  "contains": [
16    "coupon"
17  ],
18  "payload": {
19    "coupon": {
20      "state": {
21        "is_archived": false,
22        "is_public": true,
23        "is_display": false
24      },
25      "action": {
26        "action_date": null,
27        "txn_mode": "coupon"
28      },
29      "rule": [
30        {
31          "min": 0,
32          "key": 1,
33          "value": 3000,
34          "max": 0
35        }
36      ],
37      "type_slug": "absolute_quantity_absolute",
38      "display_meta": {
39        "remove": {
40          "title": "",
41          "subtitle": ""
42        },
43        "subtitle": "ICC",
44        "description": "",
45        "auto": {
46          "title": "",
47          "subtitle": ""
48        },
49        "apply": {
50          "title": "Coupon applied successfully",
51          "subtitle": ""
52        },
53        "title": "ICC"
54      },
55      "ownership": {
56        "payable_by": "",
57        "payable_category": "seller"
58      },
59      "date_meta": {
60        "modified_on": "2024-03-28T08:26:15.474938+00:00",
61        "created_on": "2024-03-28T08:21:17.516000+00:00"
62      },
63      "rule_definition": {
64        "value_type": "absolute",
65        "scope": [
66          "brand_id"
67        ],
68        "auto_apply": false,
69        "type": "absolute",
70        "applicable_on": "quantity",
71        "currency_code": "INR",
72        "calculate_on": "esp",
73        "is_exact": false
74      },
75      "tags": [
76        "platform"
77      ],
78      "author": {
79        "modified_by": "be93d7a0639c8de35f2367b3",
80        "created_by": "be93d7a0639c8de35f2367b3"
81      },
82      "_schedule": {
83        "duration": null,
84        "cron": null,
85        "next_schedule": [
86          {
87            "start": "2024-03-28T08:21:06.072000+00:00",
88            "end": null
89          }
90        ],
91        "start": "2024-03-28T08:21:06.072000+00:00",
92        "end": null
93      },
94      "validation": {
95        "user_registered_after": null,
96        "app_id": [
97          "60744d605bdf7f6a00a86ff9"
98        ],
99        "anonymous": false
100      },
101      "identifiers": {
102        "brand_id": [
103          509,
104          4445
105        ],
106        "user_id": []
107      },
108      "code": "urnishac1",
109      "restrictions": {
110        "post_order": {
111          "cancellation_allowed": true,
112          "return_allowed": false
113        },
114        "ordering_stores": [],
115        "uses": {
116          "remaining": {
117            "app": -1,
118            "user": -1,
119            "total": 1
120          },
121          "maximum": {
122            "app": -1,
123            "user": -1,
124            "total": 1
125          }
126        },
127        "platforms": [
128          "web",
129          "android",
130          "ios"
131        ],
132        "price_range": {
133          "max": -1,
134          "min": -1
135        }
136      },
137      "validity": {
138        "priority": 0
139      }
140    }
141  }
142}

Courier partner

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

Events
application/courier-partner/assign/v1
# This event is triggered when courier-partner is assigned
application/courier-partner/cancel/v1
# This event is triggered when courier-partner is canceled
application/courier-partner/ndr/v1
# This event is triggered when a courier partner's delivery attempt fails and the shipment requires scheduling a reattempt based on reattempt count

application/courier-partner/assign/v1

This event is triggered when courier-partner is assigned

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
courier-partner
object
Required
An object containing details of the shipment, pickup details, delivery details that is useful for courier partner for delivering the shipment successfully
Properties
extension_id
string
Required
extension api key
mixed_cart
boolean
defines whether shipment assigned is of mixed_cart
order_creation_time
string
Required
Order created time
MPS
boolean
Required
Indicates whether shipment is of Multi Part Shipment
qc_required
boolean
flag determines whether quality check needs to be done at delivery partner ends
pickup_details
object
Required
Address from where the shipment needs to be picked up
Properties
address
string
Required
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details
area
string
Required
A string specifying the locality or area associated with the pickup address
landmark
string
Required
A string representing a prominent nearby landmark that aids in locating the pickup address
postal_code
string
Required
A string indicating the postal code or PIN code of the pickup address area
district
string
Required
A string denoting the district of the pickup address
city
string
Required
A string denoting the city or municipality of the pickup address
country_code
string
Required
The ISO 3166-1 alpha-2 country code of the country where the business operates
state
string
Required
A string indicating the state or province of the pickup address
country
string
Required
A string indicating the country of the pickup address
e_waybill
object
An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill
contact_details
object
Required
Contact details of the person from whom the shipment needs to be picked up.
Properties
name
string
Required
Name of the contact person associated with the pickup address
phone
string
Required
Phone number associated with the pickup address user
phone_code
string
Required
Phone code for the country of the pickup address
email
string|null
Required
Email of the recipient associated with the pickup address
pickup_time
string
Required
The pickup time indicates when the store prepares the order and when delivery partners should pick up the shipments
delivery_details
object
Required
Address from where the shipment needs to be delivered
Properties
address
string
Required
A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details
area
string
Required
A string specifying the locality or area associated with the delivery address
landmark
string
Required
A string representing a prominent nearby landmark that aids in locating the delivery address
lat
number|string
Latitude is the geographic coordinate that specifies the north-south position of an delivery address
long
number|string
Longitude is the geographic coordinate that specifies the north-south position of an delivery address
postal_code
string
Required
A string indicating the postal code or PIN code of the delivery address area
district
string
Required
A string denoting the district of the delivery address
city
string
Required
A string denoting the city or municipality of the delivery address
country_code
string
Required
The ISO 3166-1 alpha-2 country code of the country where the business operates
state
string
Required
A string indicating the state or province of the delivery address
country
string
Required
A string indicating the country of the delivery address
e_waybill
object
An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill
contact_details
object
Required
Contact details of the person to whom the shipment needs to be delivered.
Properties
name
string
Required
Name of the contact person associated with the delivery address
phone
string
Required
Phone code for the country of the delivery address
email
string|null
Required
Email of the recipient associated with the delivery address
phone_code
string
Required
Phone code for the country of the delivery address
shipment_details
object
Required
Details of the product in a shipment
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
affiliate_id
string
Required
External reference id of the shipment
order_id
string
Required
Unique identifier of the order
shipment_id
string
Required
Unique identifier of the shipment
delivery_type
string
Required
A string indicating the typical flow of goods, forward (delivery to the customer) or reverse (pickup from the customer)
weight
number
Required
Weight of the shipment
order_category
null
Required
batch_id
null
Required
gstin
string|null
Required
The GSTIN (Goods and Services Tax Identification Number) number of the seller
dimensions
object|null
Required
Object containing Length, Width and Height of a package
total_item_count
integer
Required
Total quantity of the item present in the shipment
currency_code
string
Required
The ISO 4217 currency code indicates the currency in which the order was placed.
currency_conversion
object
Required
An object of the currency conversion
Properties
base
string
Required
The base currency for the conversion rates given. The 3-letter ISO 4217 currency code.
rates
object
Required
Conversion rate of the base currency
invoice
object
Required
Object containing invoice related details of the shipment.
Properties
number
string
Required
The invoice number for the current shipment.
date
string
Required
The date on which the invoice was created.
order_type
string
Required
A string indicating type of order [COD or Prepaid]
items
array of object
Required
Details of all the items in a shipment
Array of Properties
size
string
Required
A string denoting the size of the item.
prices
object
Required
Details of all the charges, refunds, taxes, etc. applicable to the product
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount refundable if order is returned
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
amount_paid_roundoff
number
Required
Amount paid rounded off
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
The percentage rate of Integrated Goods and Services Tax (GST) applied to an interstate transaction
sgst_tax_percentage
number
Required
The percentage rate of State Goods and Services Tax (GST) applied to a transaction within a State
cgst_tax_percentage
number
Required
The percentage rate of Central Goods and Services Tax (GST) applied to an intra-state transaction
igst_gst_fee
number
Required
The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction
cgst_gst_fee
number
Required
The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction
sgst_gst_fee
number
Required
The fee associated with State Goods and Services Tax (GST) for a transaction within a State
quantity
integer
Required
Quantity of products
name
string
Required
A string indicating name of the product
hsn_code
string
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
category
string
Required
A string indicating category of the product
sub_category
string
Required
A string indicating sub category classification of the product
brand
string
Required
A string indicating The brand of the item
sku
string
Required
A string indication of Stock Keeping Unit of the item
description
string
Required
A string representing a product description
images_url
array of string
Required
List of product images URL
attributes
object
Attributes of the product.
tax_head
string
Required
The tax rate applicable for the tax applicable to the product (IGST,SGST).
prices
object
Required
Details of all the charges, refunds, taxes, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount for the shipment
amount_paid
number
Required
Amount paid by the customer for the shipment
refund_amount
number
Required
Amount refundable if order is returned for the shipment
value_of_good
number
Required
Effective selling price - Product GST Amount for the shipment
price_marked
number
Required
The indicated price or value assigned to an shipment before any discounts or adjustments for the shipment
amount_paid_roundoff
number
Required
Amount paid rounded off for the shipment
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for the product or service of the shipment.
igst_gst_fee
number
Required
The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction applied to the shipment
cgst_gst_fee
number
Required
The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction applied to the shipment
sgst_gst_fee
number
Required
The fee associated with State Goods and Services Tax (GST) for a transaction within a State applied to the shipment
tax_head
string
Required
The tax rate applicable for the tax applicable to the shipment (IGST,SGST).
ewaybill_info
object
Required
Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods
shipment_id
string
Required
Unique identifier of the shipment
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      "properties": {
77        "courier-partner": {
78          "type": "object",
79          "description": "An object containing details of the shipment, pickup details, delivery details that is useful for courier partner for delivering the shipment successfully",
80          "properties": {
81            "extension_id": {
82              "type": "string",
83              "description": "extension api key"
84            },
85            "mixed_cart": {
86              "type": "boolean",
87              "description": "defines whether shipment assigned is of mixed_cart"
88            },
89            "order_creation_time": {
90              "type": "string",
91              "description": "Order created time"
92            },
93            "MPS": {
94              "type": "boolean",
95              "description": "Indicates whether shipment is of Multi Part Shipment"
96            },
97            "qc_required": {
98              "type": "boolean",
99              "description": "flag determines whether quality check needs to be done at delivery partner ends"
100            },
101            "pickup_details": {
102              "type": "object",
103              "description": "Address from where the shipment needs to be picked up",
104              "properties": {
105                "address": {
106                  "type": "string",
107                  "description": "A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
108                },
109                "area": {
110                  "type": "string",
111                  "description": "A string specifying the locality or area associated with the pickup address"
112                },
113                "landmark": {
114                  "type": "string",
115                  "description": "A string representing a prominent nearby landmark that aids in locating the pickup address"
116                },
117                "postal_code": {
118                  "type": "string",
119                  "description": "A string indicating the postal code or PIN code of the pickup address area"
120                },
121                "district": {
122                  "type": "string",
123                  "description": "A string denoting the district of the pickup address"
124                },
125                "city": {
126                  "type": "string",
127                  "description": "A string denoting the city or municipality of the pickup address"
128                },
129                "country_code": {
130                  "type": "string",
131                  "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
132                },
133                "state": {
134                  "type": "string",
135                  "description": "A string indicating the state or province of the pickup address"
136                },
137                "country": {
138                  "type": "string",
139                  "description": "A string indicating the country of the pickup address"
140                },
141                "e_waybill": {
142                  "type": "object",
143                  "description": "An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill"
144                },
145                "contact_details": {
146                  "type": "object",
147                  "description": "Contact details of the person from whom the shipment needs to be picked up.",
148                  "properties": {
149                    "name": {
150                      "type": "string",
151                      "description": "Name of the contact person associated with the pickup address"
152                    },
153                    "phone": {
154                      "type": "string",
155                      "description": "Phone number associated with the pickup address user"
156                    },
157                    "phone_code": {
158                      "type": "string",
159                      "description": "Phone code for the country of the pickup address"
160                    },
161                    "email": {
162                      "type": [
163                        "string",
164                        "null"
165                      ],
166                      "description": "Email of the recipient associated with the pickup address"
167                    }
168                  },
169                  "required": [
170                    "name",
171                    "phone",
172                    "phone_code",
173                    "email"
174                  ]
175                },
176                "pickup_time": {
177                  "type": "string",
178                  "description": "The pickup time indicates when the store prepares the order and when delivery partners should pick up the shipments"
179                }
180              },
181              "required": [
182                "address",
183                "area",
184                "landmark",
185                "postal_code",
186                "district",
187                "city",
188                "country_code",
189                "state",
190                "country",
191                "contact_details",
192                "pickup_time"
193              ]
194            },
195            "delivery_details": {
196              "type": "object",
197              "description": "Address from where the shipment needs to be delivered",
198              "properties": {
199                "address": {
200                  "type": "string",
201                  "description": "A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
202                },
203                "area": {
204                  "type": "string",
205                  "description": "A string specifying the locality or area associated with the delivery address"
206                },
207                "landmark": {
208                  "type": "string",
209                  "description": "A string representing a prominent nearby landmark that aids in locating the delivery address"
210                },
211                "lat": {
212                  "type": [
213                    "number",
214                    "string"
215                  ],
216                  "description": "Latitude is the geographic coordinate that specifies the north-south position of an delivery address"
217                },
218                "long": {
219                  "type": [
220                    "number",
221                    "string"
222                  ],
223                  "description": "Longitude is the geographic coordinate that specifies the north-south position of an delivery address"
224                },
225                "postal_code": {
226                  "type": "string",
227                  "description": "A string indicating the postal code or PIN code of the delivery address area"
228                },
229                "district": {
230                  "type": "string",
231                  "description": "A string denoting the district of the delivery address"
232                },
233                "city": {
234                  "type": "string",
235                  "description": "A string denoting the city or municipality of the delivery address"
236                },
237                "country_code": {
238                  "type": "string",
239                  "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
240                },
241                "state": {
242                  "type": "string",
243                  "description": "A string indicating the state or province of the delivery address"
244                },
245                "country": {
246                  "type": "string",
247                  "description": "A string indicating the country of the delivery address"
248                },
249                "e_waybill": {
250                  "type": "object",
251                  "description": "An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill"
252                },
253                "contact_details": {
254                  "type": "object",
255                  "description": "Contact details of the person to whom the shipment needs to be delivered.",
256                  "properties": {
257                    "name": {
258                      "type": "string",
259                      "description": "Name of the contact person associated with the delivery address"
260                    },
261                    "phone": {
262                      "type": "string",
263                      "description": "Phone code for the country of the delivery address"
264                    },
265                    "email": {
266                      "type": [
267                        "string",
268                        "null"
269                      ],
270                      "description": "Email of the recipient associated with the delivery address"
271                    },
272                    "phone_code": {
273                      "type": "string",
274                      "description": "Phone code for the country of the delivery address"
275                    }
276                  },
277                  "required": [
278                    "name",
279                    "phone",
280                    "email",
281                    "phone_code"
282                  ]
283                }
284              },
285              "required": [
286                "address",
287                "area",
288                "landmark",
289                "postal_code",
290                "district",
291                "city",
292                "country_code",
293                "state",
294                "country",
295                "contact_details"
296              ]
297            },
298            "shipment_details": {
299              "type": "object",
300              "description": "Details of the product in a shipment",
301              "properties": {
302                "ordering_channel": {
303                  "type": "string",
304                  "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
305                },
306                "ordering_source": {
307                  "type": "string",
308                  "nullable": true,
309                  "description": "To uniquely identify the source through which order has been placed.",
310                  "enum": [
311                    "storefront",
312                    "store_os_pos",
313                    "kiosk",
314                    "scan_go",
315                    "smart_trolley",
316                    "gofynd",
317                    "uniket",
318                    "marketplace",
319                    "social_commerce",
320                    "ondc",
321                    "nexus"
322                  ]
323                },
324                "affiliate_id": {
325                  "type": "string",
326                  "description": "External reference id of the shipment"
327                },
328                "order_id": {
329                  "type": "string",
330                  "description": "Unique identifier of the order"
331                },
332                "shipment_id": {
333                  "type": "string",
334                  "description": "Unique identifier of the shipment"
335                },
336                "delivery_type": {
337                  "type": "string",
338                  "description": "A string indicating the typical flow of goods, forward (delivery to the customer) or reverse (pickup from the customer)"
339                },
340                "weight": {
341                  "type": "number",
342                  "description": "Weight of the shipment"
343                },
344                "order_category": {
345                  "type": "null"
346                },
347                "batch_id": {
348                  "type": "null"
349                },
350                "gstin": {
351                  "type": [
352                    "string",
353                    "null"
354                  ],
355                  "description": "The GSTIN (Goods and Services Tax Identification Number) number of the seller"
356                },
357                "dimensions": {
358                  "type": [
359                    "object",
360                    "null"
361                  ],
362                  "description": "Object containing Length, Width and Height of a package"
363                },
364                "total_item_count": {
365                  "type": "integer",
366                  "description": "Total quantity of the item present in the shipment"
367                },
368                "currency_code": {
369                  "type": "string",
370                  "description": "The ISO 4217 currency code indicates the currency in which the order was placed."
371                },
372                "currency_conversion": {
373                  "type": "object",
374                  "description": "An object of the currency conversion",
375                  "properties": {
376                    "base": {
377                      "type": "string",
378                      "description": "The base currency for the conversion rates given. The 3-letter ISO 4217 currency code."
379                    },
380                    "rates": {
381                      "type": "object",
382                      "description": "Conversion rate of the base currency"
383                    }
384                  },
385                  "required": [
386                    "base",
387                    "rates"
388                  ]
389                },
390                "invoice": {
391                  "type": "object",
392                  "description": "Object containing invoice related details of the shipment.",
393                  "properties": {
394                    "number": {
395                      "type": "string",
396                      "description": "The invoice number for the current shipment."
397                    },
398                    "date": {
399                      "type": "string",
400                      "description": "The date on which the invoice was created."
401                    }
402                  },
403                  "required": [
404                    "number",
405                    "date"
406                  ]
407                },
408                "order_type": {
409                  "type": "string",
410                  "description": "A string indicating type of order [COD or Prepaid]"
411                },
412                "items": {
413                  "type": "array",
414                  "description": "Details of all the items in a shipment",
415                  "items": {
416                    "type": "object",
417                    "properties": {
418                      "size": {
419                        "type": "string",
420                        "description": "A string denoting the size of the item."
421                      },
422                      "prices": {
423                        "type": "object",
424                        "description": "Details of all the charges, refunds, taxes, etc. applicable to the product",
425                        "properties": {
426                          "price_effective": {
427                            "type": "number",
428                            "description": "MRP - Initial Seller provided discount"
429                          },
430                          "amount_paid": {
431                            "type": "number",
432                            "description": "Amount paid by the customer"
433                          },
434                          "refund_amount": {
435                            "type": "number",
436                            "description": "Amount refundable if order is returned"
437                          },
438                          "gst_tax_percentage": {
439                            "type": "number",
440                            "description": "The percentage rate of GST applied to a product or service"
441                          },
442                          "value_of_good": {
443                            "type": "number",
444                            "description": "Effective selling price - Product GST Amount"
445                          },
446                          "price_marked": {
447                            "type": "number",
448                            "description": "The indicated price or value assigned to an item before any discounts or adjustments"
449                          },
450                          "amount_paid_roundoff": {
451                            "type": "number",
452                            "description": "Amount paid rounded off"
453                          },
454                          "gst_fee": {
455                            "type": "number",
456                            "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
457                          },
458                          "igst_tax_percentage": {
459                            "type": "number",
460                            "description": "The percentage rate of Integrated Goods and Services Tax (GST) applied to an interstate transaction"
461                          },
462                          "sgst_tax_percentage": {
463                            "type": "number",
464                            "description": "The percentage rate of State Goods and Services Tax (GST) applied to a transaction within a State"
465                          },
466                          "cgst_tax_percentage": {
467                            "type": "number",
468                            "description": "The percentage rate of Central Goods and Services Tax (GST) applied to an intra-state transaction"
469                          },
470                          "igst_gst_fee": {
471                            "type": "number",
472                            "description": "The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction"
473                          },
474                          "cgst_gst_fee": {
475                            "type": "number",
476                            "description": "The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction"
477                          },
478                          "sgst_gst_fee": {
479                            "type": "number",
480                            "description": "The fee associated with State Goods and Services Tax (GST) for a transaction within a State"
481                          }
482                        },
483                        "required": [
484                          "price_effective",
485                          "amount_paid",
486                          "refund_amount",
487                          "gst_tax_percentage",
488                          "value_of_good",
489                          "price_marked",
490                          "amount_paid_roundoff",
491                          "gst_fee",
492                          "igst_tax_percentage",
493                          "sgst_tax_percentage",
494                          "cgst_tax_percentage",
495                          "igst_gst_fee",
496                          "cgst_gst_fee",
497                          "sgst_gst_fee"
498                        ]
499                      },
500                      "quantity": {
501                        "type": "integer",
502                        "description": "Quantity of products"
503                      },
504                      "name": {
505                        "type": "string",
506                        "description": "A string indicating name of the product"
507                      },
508                      "hsn_code": {
509                        "type": "string",
510                        "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
511                      },
512                      "category": {
513                        "type": "string",
514                        "description": "A string indicating category of the product"
515                      },
516                      "sub_category": {
517                        "type": "string",
518                        "description": "A string indicating sub category classification of the product"
519                      },
520                      "brand": {
521                        "type": "string",
522                        "description": "A string indicating The brand of the item"
523                      },
524                      "sku": {
525                        "type": "string",
526                        "description": "A string indication of Stock Keeping Unit of the item"
527                      },
528                      "description": {
529                        "type": "string",
530                        "description": "A string representing a product description"
531                      },
532                      "images_url": {
533                        "type": "array",
534                        "description": "List of product images URL",
535                        "items": {
536                          "type": "string"
537                        }
538                      },
539                      "attributes": {
540                        "type": "object",
541                        "description": "Attributes of the product."
542                      },
543                      "tax_head": {
544                        "type": "string",
545                        "description": "The tax rate applicable for the tax applicable to the product (IGST,SGST)."
546                      }
547                    },
548                    "required": [
549                      "size",
550                      "prices",
551                      "quantity",
552                      "name",
553                      "hsn_code",
554                      "category",
555                      "sub_category",
556                      "brand",
557                      "sku",
558                      "description",
559                      "images_url",
560                      "tax_head"
561                    ]
562                  }
563                },
564                "prices": {
565                  "type": "object",
566                  "description": "Details of all the charges, refunds, taxes, etc. applicable to the shipment",
567                  "properties": {
568                    "price_effective": {
569                      "type": "number",
570                      "description": "MRP - Initial Seller provided discount for the shipment"
571                    },
572                    "amount_paid": {
573                      "type": "number",
574                      "description": "Amount paid by the customer for the shipment"
575                    },
576                    "refund_amount": {
577                      "type": "number",
578                      "description": "Amount refundable if order is returned for the shipment"
579                    },
580                    "value_of_good": {
581                      "type": "number",
582                      "description": "Effective selling price - Product GST Amount for the shipment"
583                    },
584                    "price_marked": {
585                      "type": "number",
586                      "description": "The indicated price or value assigned to an shipment before any discounts or adjustments for the shipment"
587                    },
588                    "amount_paid_roundoff": {
589                      "type": "number",
590                      "description": "Amount paid rounded off for the shipment"
591                    },
592                    "gst_fee": {
593                      "type": "number",
594                      "description": "The fee associated with Goods and Services Tax (GST) for the product or service of the shipment."
595                    },
596                    "igst_gst_fee": {
597                      "type": "number",
598                      "description": "The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction applied to the shipment"
599                    },
600                    "cgst_gst_fee": {
601                      "type": "number",
602                      "description": "The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction applied to the shipment"
603                    },
604                    "sgst_gst_fee": {
605                      "type": "number",
606                      "description": "The fee associated with State Goods and Services Tax (GST) for a transaction within a State applied to the shipment"
607                    },
608                    "tax_head": {
609                      "type": "string",
610                      "description": "The tax rate applicable for the tax applicable to the shipment (IGST,SGST)."
611                    }
612                  },
613                  "required": [
614                    "price_effective",
615                    "amount_paid",
616                    "refund_amount",
617                    "value_of_good",
618                    "price_marked",
619                    "amount_paid_roundoff",
620                    "gst_fee",
621                    "igst_gst_fee",
622                    "cgst_gst_fee",
623                    "sgst_gst_fee",
624                    "tax_head"
625                  ]
626                }
627              },
628              "required": [
629                "ordering_channel",
630                "affiliate_id",
631                "order_id",
632                "shipment_id",
633                "delivery_type",
634                "weight",
635                "order_category",
636                "batch_id",
637                "gstin",
638                "dimensions",
639                "total_item_count",
640                "currency_code",
641                "currency_conversion",
642                "invoice",
643                "order_type",
644                "items",
645                "prices"
646              ]
647            },
648            "ewaybill_info": {
649              "type": "object",
650              "description": "Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods"
651            }
652          },
653          "required": [
654            "extension_id",
655            "order_creation_time",
656            "MPS",
657            "pickup_details",
658            "delivery_details",
659            "shipment_details",
660            "ewaybill_info"
661          ]
662        },
663        "shipment_id": {
664          "type": "string",
665          "description": "Unique identifier of the shipment"
666        }
667      },
668      "required": [
669        "courier-partner",
670        "shipment_id"
671      ]
672    }
673  }
674}
Payload Example
1{
2  "application_id": [
3    "6365f991cd0a31594e443bce",
4    "*"
5  ],
6  "company_id": 3523,
7  "contains": [
8    "shipment_id",
9    "courier-partner"
10  ],
11  "event": {
12    "category": "application",
13    "created_timestamp": 1712161343,
14    "id": "dTEeqnGsRT540xwEW2aFzsh53FFXLIg2pjpKyS/x0Ns=",
15    "name": "courier-partner",
16    "trace_id": [
17      "0000000000000000ba8a2062b3d44235"
18    ],
19    "type": "assign",
20    "version": "1"
21  },
22  "payload": {
23    "courier-partner": {
24      "MPS": false,
25      "delivery_details": {
26        "address": " test test",
27        "area": "test ",
28        "city": "test",
29        "contact_details": {
30          "email": "test@example.com",
31          "name": "test test",
32          "phone": "1111111111",
33          "phone_code": "+91"
34        },
35        "country": "India",
36        "country_code": "IN",
37        "country_iso_code": "IN",
38        "district": "",
39        "landmark": " mandir",
40        "lat": "",
41        "long": "",
42        "postal_code": "781354",
43        "sector": "",
44        "state": "Assam"
45      },
46      "ewaybill_info": {},
47      "extension_id": "656f1f18c24dabc79325b1ba",
48      "mixed_cart": false,
49      "order_creation_time": "2024-04-03T11:47:03+00:00",
50      "pickup_details": {
51        "address": "test test 782003\nIndia   test",
52        "area": "",
53        "city": "Nagaon",
54        "contact_details": {
55          "company": {
56            "address": [
57              {
58                "address1": "\nINDIA",
59                "address_type": "office",
60                "city": "Howrah",
61                "country": "INDIA",
62                "country_code": "IN",
63                "country_iso_code": "IN",
64                "display_address": ", test",
65                "latitude": 22.5957689,
66                "longitude": 88.26363940000002,
67                "pincode": 711104,
68                "state": "West Bengal"
69              },
70              {
71                "address1": " test",
72                "address_type": "registered",
73                "city": "Howrah",
74                "country": "INDIA",
75                "country_code": "IN",
76                "country_iso_code": "IN",
77                "display_address": "test",
78                "latitude": 22.5957689,
79                "longitude": 88.26363940000002,
80                "pincode": 711104,
81                "state": "West Bengal"
82              }
83            ],
84            "name": "test"
85          },
86          "email": "test@example.com",
87          "name": "SB-NAGAON",
88          "phone": "1111111111",
89          "phone_code": "91"
90        },
91        "country": "India",
92        "country_code": "IN",
93        "country_iso_code": "IN",
94        "district": "",
95        "e_waybill": {
96          "enabled": false,
97          "ewaybill_portal_details": {}
98        },
99        "landmark": "SHREE SMITA COMMERCIAL COMPLEX ITACHALI",
100        "lat": 26.3462288,
101        "long": 92.7185992,
102        "merchant_id": null,
103        "pickup_location_id": 20914,
104        "pickup_time": "2024-04-03 21:52:23",
105        "postal_code": "782003",
106        "sector": "",
107        "state": "Assam"
108      },
109      "qc_required": true,
110      "rto_details": {
111        "address": "test",
112        "area": "",
113        "city": "Nagaon",
114        "contact_details": {
115          "company": {
116            "address": [
117              {
118                "address1": " test",
119                "address_type": "office",
120                "city": "Howrah",
121                "country": "INDIA",
122                "country_code": "IN",
123                "country_iso_code": "IN",
124                "display_address": ", test",
125                "latitude": 22.5957689,
126                "longitude": 88.26363940000002,
127                "pincode": 711104,
128                "state": "West Bengal"
129              },
130              {
131                "address1": " test",
132                "address_type": "registered",
133                "city": "Howrah",
134                "country": "INDIA",
135                "country_code": "IN",
136                "country_iso_code": "IN",
137                "display_address": " test",
138                "latitude": 22.5957689,
139                "longitude": 88.26363940000002,
140                "pincode": 711104,
141                "state": "West Bengal"
142              }
143            ],
144            "name": "Baazar Style Retail Limited"
145          },
146          "email": "test@example.com",
147          "name": "SB-NAGAON",
148          "phone": "1111111111",
149          "phone_code": "91"
150        },
151        "country": "India",
152        "country_code": "IN",
153        "country_iso_code": "IN",
154        "district": "",
155        "landmark": "test",
156        "lat": 26.3462288,
157        "long": 92.7185992,
158        "merchant_id": null,
159        "pickup_time": "2024-04-03 21:52:23",
160        "postal_code": "782003",
161        "sector": "",
162        "state": "Assam"
163      },
164      "scheme_id": "65952a7b199ac0fd9537b1a7",
165      "shipment_details": {
166        "affiliate_id": "6365f991cd0a31594e443bce",
167        "batch_id": null,
168        "currency_code": "INR",
169        "currency_conversion": {
170          "base": "INR",
171          "rates": {
172            "INR": {
173              "name": "Indian Rupee",
174              "sub_unit": "Paisa",
175              "symbol": "₹",
176              "value": 1
177            }
178          },
179          "timestamp": 1712102400000
180        },
181        "delivery_type": "forward",
182        "dimensions": {
183          "height": 7,
184          "length": 35.56,
185          "width": 29.21
186        },
187        "gstin": "18AAECD7575J1Z5",
188        "invoice": {
189          "created_ts": "2024-04-03T21:52:22Z",
190          "date": "2024-04-03T21:52:22+00:00",
191          "number": "E00020914A000051"
192        },
193        "items": [
194          {
195            "attributes": {
196              "brand_name": "STYLE BAAZAR",
197              "essential": "No",
198              "gender": [
199                "Men"
200              ],
201              "is_food": null,
202              "marketer-address": " test address",
203              "marketer-name": "Style Baazar",
204              "name": "SHIRT HS (MC)",
205              "net-quantity": "1 N",
206              "primary_color": "White",
207              "primary_color_hex": "FFFFFF",
208              "primary_material": "Others",
209              "season": "SS24_Q1",
210              "weight": 250
211            },
212            "brand": "STYLE BAAZAR",
213            "category": "Dresses & Jumpsuits",
214            "child_details": [],
215            "color": "White",
216            "description": "SHIRT HS (MC) SB3207206 Dresses & Jumpsuits Shirt Dress",
217            "hsn_code": "62032900",
218            "images_url": [
219              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/common/default_item_image.jpg"
220            ],
221            "l1_category": [
222              "Clothing"
223            ],
224            "name": "SHIRT HS (MC)",
225            "prices": {
226              "amount_paid": 499,
227              "amount_paid_roundoff": 499,
228              "cgst_gst_fee": 11.88,
229              "cgst_tax_percentage": 2.5,
230              "gst_fee": 23.76,
231              "gst_tax_percentage": 5,
232              "igst_gst_fee": 0,
233              "igst_tax_percentage": 0,
234              "price_effective": 499,
235              "price_marked": 499,
236              "refund_amount": 499,
237              "sgst_gst_fee": 11.88,
238              "sgst_tax_percentage": 2.5,
239              "value_of_good": 475.24
240            },
241            "quantity": 1,
242            "return_qc_json": {},
243            "size": "2XL-44 INCH",
244            "sku": "SB3207206",
245            "sub_category": "Shirt Dress",
246            "tax_head": "SGST"
247          }
248        ],
249        "order_category": null,
250        "order_id": "FY660CF45F0ED654F87D",
251        "order_type": "COD",
252        "ordering_channel": "FYND_STORE",
253        "ordering_source": "store_os_pos",
254        "prices": {
255          "amount_paid": 499,
256          "amount_paid_roundoff": 499,
257          "cgst_gst_fee": 11.88,
258          "gst_fee": 23.76,
259          "igst_gst_fee": 0,
260          "price_effective": 499,
261          "price_marked": 499,
262          "refund_amount": 499,
263          "sgst_gst_fee": 11.88,
264          "tax_head": "SGST",
265          "value_of_good": 475.24
266        },
267        "shipment_id": "17121570428911842368",
268        "total_item_count": 1,
269        "weight": 250
270      }
271    },
272    "shipment_id": "17121570428911842368"
273  }
274}

application/courier-partner/cancel/v1

This event is triggered when courier-partner is canceled

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
courier-partner
object
Required
Properties
extension_id
string
Required
extension api key
scheme_id
string
unique id of scheme
mixed_cart
boolean
Required
defines whether shipment assigned is of mixed_cart
order_creation_time
string
Required
Order created time
MPS
boolean
Required
Indicates whether shipment is of Multi Part Shipment
qc_required
boolean
Required
flag determines whether quality check needs to be done at delivery partner ends
awb_number
string
Required
AWB number assigned
shipment_id
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      "properties": {
77        "courier-partner": {
78          "type": "object",
79          "properties": {
80            "extension_id": {
81              "type": "string",
82              "description": "extension api key"
83            },
84            "scheme_id": {
85              "type": "string",
86              "description": "unique id of scheme"
87            },
88            "mixed_cart": {
89              "type": "boolean",
90              "description": "defines whether shipment assigned is of mixed_cart"
91            },
92            "order_creation_time": {
93              "type": "string",
94              "description": "Order created time"
95            },
96            "MPS": {
97              "type": "boolean",
98              "description": "Indicates whether shipment is of Multi Part Shipment"
99            },
100            "qc_required": {
101              "type": "boolean",
102              "description": "flag determines whether quality check needs to be done at delivery partner ends"
103            },
104            "awb_number": {
105              "type": "string",
106              "description": "AWB number assigned"
107            }
108          },
109          "required": [
110            "extension_id",
111            "mixed_cart",
112            "order_creation_time",
113            "MPS",
114            "qc_required",
115            "awb_number"
116          ]
117        },
118        "shipment_id": {
119          "type": "string"
120        }
121      },
122      "required": [
123        "courier-partner",
124        "shipment_id"
125      ]
126    }
127  }
128}
Payload Example
1{
2  "application_id": [
3    "625e5c3709a289b56d6d4621",
4    "*"
5  ],
6  "company_id": 2250,
7  "contains": [
8    "shipment_id",
9    "courier-partner"
10  ],
11  "event": {
12    "category": "application",
13    "created_timestamp": 1712041791,
14    "id": "Tz4/K0LgVBWRE7wRZpA+9lkREpWxKaR3T3mdecE6kTY=",
15    "name": "courier-partner",
16    "trace_id": [
17      "000000000000000047cd6c09bb46d1f1"
18    ],
19    "type": "cancel",
20    "version": "1"
21  },
22  "payload": {
23    "courier-partner": {
24      "MPS": false,
25      "awb_number": "998942173750",
26      "extension_id": "656f1f18c24dabc79325b1ba",
27      "mixed_cart": false,
28      "order_creation_time": "2024-03-25T18:41:09+00:00",
29      "qc_required": true,
30      "scheme_id": "65952a7b199ac0fd9537b1a7"
31    },
32    "shipment_id": "17117038817621037997"
33  }
34}

application/courier-partner/ndr/v1

This event is triggered when a courier partner's delivery attempt fails and the shipment requires scheduling a reattempt based on reattempt count

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
courier-partner
object
Required
Properties
extension_id
string
Required
scheme_id
string
awb
string
Required
action
string
schedule_date
string
delivery_address
object
alternate_phone
string
remark
string
shipment_id
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      "properties": {
77        "courier-partner": {
78          "type": "object",
79          "properties": {
80            "extension_id": {
81              "type": "string"
82            },
83            "scheme_id": {
84              "type": "string"
85            },
86            "awb": {
87              "type": "string"
88            },
89            "action": {
90              "type": "string"
91            },
92            "schedule_date": {
93              "type": "string"
94            },
95            "delivery_address": {
96              "type": "object"
97            },
98            "alternate_phone": {
99              "type": "string"
100            },
101            "remark": {
102              "type": "string"
103            }
104          },
105          "required": [
106            "extension_id",
107            "awb"
108          ]
109        },
110        "shipment_id": {
111          "type": "string"
112        }
113      },
114      "required": [
115        "courier-partner",
116        "shipment_id"
117      ]
118    }
119  }
120}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "8fbfdacb721d99f2551612caffcf4626"
5    ],
6    "name": "courier-partner",
7    "type": "ndr",
8    "version": "1",
9    "created_timestamp": 1714493912,
10    "id": "O8MqLspwLuLWfXQy+V+1mn4jYngKSVVNop56H0jxAVM=",
11    "category": "application",
12    "referer": "sit.fyndx1.de"
13  },
14  "company_id": 2,
15  "application_id": [
16    "64aed475db2cfb5b8a9f623d",
17    "*"
18  ],
19  "contains": [
20    "shipment_info",
21    "shipment_id",
22    "courier-partner"
23  ],
24  "payload": {
25    "shipment_info": {
26      "extension_id": "6543d9e612912d23cb13da1a",
27      "scheme_id": "6569e9eb0a578b0045552338",
28      "mixed_cart": false,
29      "order_creation_time": "2024-04-25T17:05:03+00:00",
30      "MPS": false,
31      "qc_required": true
32    },
33    "shipment_id": "17140449027591545985",
34    "courier-partner": {
35      "action": "re-schedule",
36      "remark": "fewfefwe",
37      "schedule_date": "2024-05-02T16:18:32.521183Z",
38      "alternate_phone": "8888888888",
39      "delivery_address": {
40        "address": "aterere",
41        "id": "66278f5e53c381c500fbe785",
42        "uid": 48923,
43        "area": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik",
44        "city": "PUNE",
45        "name": "ssss",
46        "email": "test@example.com",
47        "phone": "8888888888",
48        "state": "MAHARASHTRA",
49        "sector": "",
50        "country": "India",
51        "pincode": "411045",
52        "user_id": 296,
53        "version": "1.0",
54        "address1": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
55        "address2": "",
56        "landmark": "",
57        "latitude": 19.1570343,
58        "area_code": "411045",
59        "longitude": 72.93274439999999,
60        "created_at": "2024-04-25 17:05:02",
61        "state_code": "MH",
62        "updated_at": "2024-04-25 17:05:02",
63        "address_type": "office",
64        "country_code": "+91",
65        "geo_location": {
66          "latitude": 19.1570343,
67          "longitude": 72.93274439999999
68        },
69        "area_code_slug": "pincode",
70        "contact_person": "ssss",
71        "display_address": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
72        "address_category": "",
73        "country_iso_code": "IN",
74        "country_phone_code": "+91",
75        "delivery_address_id": 48923
76      },
77      "awb": "6806110011756",
78      "auto_action_taken": false,
79      "extension_id": "6543d9e612912d23cb13da1a",
80      "scheme_id": "6569e9eb0a578b0045552338"
81    }
82  }
83}

Customer credit note configuration

This event tracks changes to customer credit note configurations, including creation and updating. It provides essential information about the configuration and the action performed.

Events
application/customer_credit_note_configuration/create/v1
# This event is triggered when a customer credit note configuration is created. It contains details about the configuration and the action performed.
application/customer_credit_note_configuration/update/v1
# This event is triggered when a customer credit note configuration is updated. It contains details about the configuration and the action performed.

application/customer_credit_note_configuration/create/v1

This event is triggered when a customer credit note configuration is created. It contains details about the configuration and the action performed.

Payload
Properties
application_id
array|string
Required
Sales channel ID for which this event is triggered
company_id
integer
Required
The unique identifier of the company.
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
The category of the event, e.g., whether 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 the event, which can be used to verify if the event has already been processed by the 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.
version
string
Required
Version of the event.
payload
object
Required
Payload associated with the event.
Properties
company_id
integer
Required
The unique identifier of the company.
affiliate_id
string
Required
Affiliate ID associated with the configuration.
is_active
boolean
Required
Indicates whether the configuration is active.
is_cn_as_refund_method
boolean
Required
Indicates whether the CN is used as a refund method.
validity
integer
Required
Credit note expiry period in days.
issuance_ordering_channels
array of
Required
Channel through which orders are placed.
redemption_ordering_channels
array of
Required
Source channel for the configuration.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "description": "Event emitted when a customer credit note configuration is changed.",
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "The unique identifier of the company."
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      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "description": "The category of the event, e.g., whether it is at sales channel level or company level."
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds."
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for the event, which can be used to verify if the event has already been processed by the receiver."
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event."
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace ID for Fynd Platform services.",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event, e.g., create/update."
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "description": "Payload associated with the event.",
78      "required": [
79        "company_id",
80        "affiliate_id",
81        "is_active",
82        "is_cn_as_refund_method",
83        "validity",
84        "issuance_ordering_channels",
85        "redemption_ordering_channels"
86      ],
87      "properties": {
88        "company_id": {
89          "type": "integer",
90          "description": "The unique identifier of the company."
91        },
92        "affiliate_id": {
93          "type": "string",
94          "description": "Affiliate ID associated with the configuration."
95        },
96        "is_active": {
97          "type": "boolean",
98          "description": "Indicates whether the configuration is active."
99        },
100        "is_cn_as_refund_method": {
101          "type": "boolean",
102          "description": "Indicates whether the CN is used as a refund method."
103        },
104        "validity": {
105          "type": "integer",
106          "description": "Credit note expiry period in days."
107        },
108        "issuance_ordering_channels": {
109          "type": "array",
110          "description": "Channel through which orders are placed."
111        },
112        "redemption_ordering_channels": {
113          "type": "array",
114          "description": "Source channel for the configuration."
115        }
116      }
117    }
118  }
119}
Payload Example
1{
2  "description": "Example of a create event for customer credit note configuration",
3  "value": {
4    "event": {
5      "name": "customer_credit_note_configuration",
6      "type": "create",
7      "version": "v1",
8      "created_timestamp": 1726560641,
9      "id": "16094052fe3101e7b32b7c4f90348b7a",
10      "category": "company",
11      "trace_id": [
12        "16094052fe3101e7b32b7c4f90348b7a"
13      ]
14    },
15    "contains": [
16      "company_id",
17      "affiliate_id",
18      "is_active",
19      "is_cn_as_refund_method",
20      "validity",
21      "issuance_ordering_channels",
22      "redemption_ordering_channels"
23    ],
24    "payload": {
25      "company_id": 661,
26      "affiliate_id": "649c1abece3fb4af7362edcd",
27      "is_active": true,
28      "is_cn_as_refund_method": true,
29      "validity": 100,
30      "issuance_ordering_channels": [
31        "platform-pos"
32      ],
33      "redemption_ordering_channels": [
34        "platform-pos"
35      ]
36    }
37  }
38}

application/customer_credit_note_configuration/update/v1

This event is triggered when a customer credit note configuration is updated. It contains details about the configuration and the action performed.

Payload
Properties
application_id
array|string
Required
Sales channel ID for which this event is triggered
company_id
integer
Required
The unique identifier of the company.
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
The category of the event, e.g., whether 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 the event, which can be used to verify if the event has already been processed by the 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.
version
string
Required
Version of the event.
payload
object
Required
Payload associated with the event.
Properties
company_id
integer
Required
The unique identifier of the company.
affiliate_id
string
Required
Affiliate ID associated with the configuration.
is_active
boolean
Required
Indicates whether the configuration is active.
is_cn_as_refund_method
boolean
Required
Indicates whether the CN is used as a refund method.
validity
integer
Required
Credit note expiry period in days.
issuance_ordering_channels
array of
Required
Channel through which orders are placed.
redemption_ordering_channels
array of
Required
Source channel for the configuration.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "application_id"
9  ],
10  "description": "Event emitted when a customer credit note configuration is changed.",
11  "properties": {
12    "application_id": {
13      "type": [
14        "array",
15        "string"
16      ],
17      "description": "Sales channel ID for which this event is triggered"
18    },
19    "company_id": {
20      "type": "integer",
21      "description": "The unique identifier of the company."
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      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "description": "The category of the event, e.g., whether it is at sales channel level or company level."
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds."
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for the event, which can be used to verify if the event has already been processed by the receiver."
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event."
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace ID for Fynd Platform services.",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event, e.g., create/update."
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "description": "Payload associated with the event.",
78      "required": [
79        "company_id",
80        "affiliate_id",
81        "is_active",
82        "is_cn_as_refund_method",
83        "validity",
84        "issuance_ordering_channels",
85        "redemption_ordering_channels"
86      ],
87      "properties": {
88        "company_id": {
89          "type": "integer",
90          "description": "The unique identifier of the company."
91        },
92        "affiliate_id": {
93          "type": "string",
94          "description": "Affiliate ID associated with the configuration."
95        },
96        "is_active": {
97          "type": "boolean",
98          "description": "Indicates whether the configuration is active."
99        },
100        "is_cn_as_refund_method": {
101          "type": "boolean",
102          "description": "Indicates whether the CN is used as a refund method."
103        },
104        "validity": {
105          "type": "integer",
106          "description": "Credit note expiry period in days."
107        },
108        "issuance_ordering_channels": {
109          "type": "array",
110          "description": "Channel through which orders are placed."
111        },
112        "redemption_ordering_channels": {
113          "type": "array",
114          "description": "Source channel for the configuration."
115        }
116      }
117    }
118  }
119}
Payload Example
1{
2  "description": "Example of a create event for customer credit note configuration",
3  "value": {
4    "event": {
5      "name": "customer_credit_note_configuration",
6      "type": "create",
7      "version": "v1",
8      "created_timestamp": 1726560641,
9      "id": "16094052fe3101e7b32b7c4f90348b7a",
10      "category": "company",
11      "trace_id": [
12        "16094052fe3101e7b32b7c4f90348b7a"
13      ]
14    },
15    "contains": [
16      "company_id",
17      "affiliate_id",
18      "is_active",
19      "is_cn_as_refund_method",
20      "validity",
21      "issuance_ordering_channels",
22      "redemption_ordering_channels"
23    ],
24    "payload": {
25      "company_id": 661,
26      "affiliate_id": "649c1abece3fb4af7362edcd",
27      "is_active": true,
28      "is_cn_as_refund_method": true,
29      "validity": 100,
30      "issuance_ordering_channels": [
31        "platform-pos"
32      ],
33      "redemption_ordering_channels": [
34        "platform-pos"
35      ]
36    }
37  }
38}

Customfield definition

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

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

application/customfield_definition/create/v1

This event is triggered when a customfield definition 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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
application_id
string
Required
This is application id where this custom fields created.
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
80        },
81        "namespace": {
82          "type": "string",
83          "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
84        },
85        "name": {
86          "type": "string",
87          "description": "Name of the custom fields. Its editable."
88        },
89        "description": {
90          "type": "string",
91          "description": "This is description about the custom field definition."
92        },
93        "id": {
94          "type": "string",
95          "description": "Uniquely generated mongoId of custom field definition and its not editable."
96        },
97        "type": {
98          "type": "string",
99          "description": "This is field_type of the custom field definition. Its non-editable"
100        },
101        "is_deleted": {
102          "type": "boolean",
103          "description": "This indicates that this custom fields definition is deleted or not."
104        },
105        "validations": {
106          "type": "array",
107          "items": {},
108          "description": "validations array have supported validations for the custom field definition"
109        },
110        "multi_value": {
111          "type": "boolean",
112          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
113        },
114        "resource": {
115          "type": "string",
116          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
117        },
118        "company_id": {
119          "type": "string",
120          "description": "This is company id where this custom fields created."
121        },
122        "application_id": {
123          "type": "string",
124          "description": "This is application id where this custom fields created."
125        },
126        "required": {
127          "type": "boolean",
128          "description": "This indicates whether the field is required or not"
129        }
130      },
131      "required": [
132        "slug",
133        "namespace",
134        "name",
135        "type",
136        "id",
137        "multi_value",
138        "resource",
139        "company_id",
140        "application_id"
141      ]
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.2f918af5-87be-475d-9d43-db71691b85a9"
5    ],
6    "name": "customfield_definition",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711535331878,
10    "id": "s9AQbr1rkiKRERCognO7jv6O/lNxcTFb7dzak6g0+J8=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "resource",
18    "name",
19    "namespace",
20    "slug",
21    "description",
22    "type",
23    "multi_value",
24    "validations",
25    "company_id",
26    "application_id",
27    "required",
28    "is_deleted",
29    "id"
30  ],
31  "payload": {
32    "resource": "coupon",
33    "name": "HTML UI",
34    "namespace": "custom",
35    "slug": "html-ui",
36    "description": "",
37    "type": "html",
38    "multi_value": false,
39    "validations": [],
40    "company_id": "1",
41    "application_id": "64c00b72c07acacc1357503b",
42    "required": false,
43    "is_deleted": false,
44    "id": "6603f4e34b3c0a047f61ea53"
45  }
46}

application/customfield_definition/delete/v1

This event is triggered when a customfield definition 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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
Required
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
application_id
string
Required
This is application id where this custom fields created.
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
80        },
81        "namespace": {
82          "type": "string",
83          "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
84        },
85        "name": {
86          "type": "string",
87          "description": "Name of the custom fields. Its editable."
88        },
89        "description": {
90          "type": "string",
91          "description": "This is description about the custom field definition."
92        },
93        "id": {
94          "type": "string",
95          "description": "Uniquely generated mongoId of custom field definition and its not editable."
96        },
97        "type": {
98          "type": "string",
99          "description": "This is field_type of the custom field definition. Its non-editable"
100        },
101        "is_deleted": {
102          "type": "boolean",
103          "description": "This indicates that this custom fields definition is deleted or not."
104        },
105        "validations": {
106          "type": "array",
107          "items": {},
108          "description": "validations array have supported validations for the custom field definition"
109        },
110        "multi_value": {
111          "type": "boolean",
112          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
113        },
114        "resource": {
115          "type": "string",
116          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
117        },
118        "company_id": {
119          "type": "string",
120          "description": "This is company id where this custom fields created."
121        },
122        "application_id": {
123          "type": "string",
124          "description": "This is application id where this custom fields created."
125        },
126        "required": {
127          "type": "boolean",
128          "description": "This indicates whether the field is required or not"
129        }
130      },
131      "required": [
132        "slug",
133        "namespace",
134        "name",
135        "type",
136        "id",
137        "is_deleted",
138        "multi_value",
139        "resource",
140        "company_id",
141        "application_id"
142      ]
143    }
144  }
145}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.563291b0-84b6-4578-89a5-d181734a1c6a"
5    ],
6    "name": "customfield_definition",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1710578622703,
10    "id": "qezDS9jcLyk53MknA03MZ2twOlEYXVo0YNriAwxsoqg=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "resource",
19    "name",
20    "namespace",
21    "slug",
22    "description",
23    "type",
24    "multi_value",
25    "validations",
26    "company_id",
27    "application_id",
28    "required",
29    "is_deleted"
30  ],
31  "payload": {
32    "id": "65f2b9fe55d09ea4b85b9c43",
33    "resource": "product",
34    "name": "Custom Object",
35    "namespace": "custom",
36    "slug": "custom-object",
37    "description": "",
38    "type": "metaobject",
39    "multi_value": false,
40    "validations": [
41      {
42        "name": "metaobject_definition_id",
43        "type": "string",
44        "value": "65af838f9fb5333f5a966118"
45      }
46    ],
47    "company_id": "1",
48    "application_id": "64c00b72c07acacc1357503b",
49    "required": false,
50    "is_deleted": true
51  }
52}

application/customfield_definition/update/v1

This event is triggered when a customfield definition 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
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
application_id
string
Required
This is application id where this custom fields created.
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "slug": {
78          "type": "string",
79          "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
80        },
81        "namespace": {
82          "type": "string",
83          "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
84        },
85        "name": {
86          "type": "string",
87          "description": "Name of the custom fields. Its editable."
88        },
89        "description": {
90          "type": "string",
91          "description": "This is description about the custom field definition."
92        },
93        "id": {
94          "type": "string",
95          "description": "Uniquely generated mongoId of custom field definition and its not editable."
96        },
97        "type": {
98          "type": "string",
99          "description": "This is field_type of the custom field definition. Its non-editable"
100        },
101        "is_deleted": {
102          "type": "boolean",
103          "description": "This indicates that this custom fields definition is deleted or not."
104        },
105        "validations": {
106          "type": "array",
107          "items": {},
108          "description": "validations array have supported validations for the custom field definition"
109        },
110        "multi_value": {
111          "type": "boolean",
112          "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
113        },
114        "resource": {
115          "type": "string",
116          "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
117        },
118        "company_id": {
119          "type": "string",
120          "description": "This is company id where this custom fields created."
121        },
122        "application_id": {
123          "type": "string",
124          "description": "This is application id where this custom fields created."
125        },
126        "required": {
127          "type": "boolean",
128          "description": "This indicates whether the field is required or not"
129        }
130      },
131      "required": [
132        "slug",
133        "namespace",
134        "name",
135        "type",
136        "id",
137        "multi_value",
138        "resource",
139        "company_id",
140        "application_id"
141      ]
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.beca0ae6-6d5b-43c2-be00-146d2d87a20f"
5    ],
6    "name": "customfield_definition",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711212304285,
10    "id": "LC63iQHuawXODo6qEwcJ0yc9d8ZuNVC36ZH+ljW+Bho=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "resource",
19    "name",
20    "namespace",
21    "slug",
22    "description",
23    "type",
24    "multi_value",
25    "validations",
26    "company_id",
27    "application_id",
28    "required",
29    "is_deleted"
30  ],
31  "payload": {
32    "id": "65fefeeacd286b467dcae16c",
33    "resource": "product",
34    "name": "tetsc1 edited",
35    "namespace": "custom",
36    "slug": "tetsc1",
37    "description": "",
38    "type": "metaobject",
39    "multi_value": true,
40    "validations": [
41      {
42        "name": "metaobject_definition_id",
43        "type": "string",
44        "value": "65af838f9fb5333f5a966118"
45      }
46    ],
47    "company_id": "1",
48    "application_id": "64c00b72c07acacc1357503b",
49    "required": false,
50    "is_deleted": false
51  }
52}

Customfields

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

Events
application/customfields/bag-update/v1
# This event is triggered when a custom field from bag is updated
application/customfields/coupon-update/v1
# This event is triggered when a custom field from Coupon is updated
application/customfields/product-update/v1
# This event is triggered when a custom field from product is updated
application/customfields/promotion-update/v1
# This event is triggered when a custom field from promotion is updated

application/customfields/bag-update/v1

This event is triggered when a custom field from bag 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
array of Undefined Type
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": "array",
76      "items": [
77        {
78          "type": "object",
79          "properties": {
80            "id": {
81              "type": "string",
82              "description": "Uniquely generated mongoId of custom field and its not editable."
83            },
84            "namespace": {
85              "type": "string",
86              "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
91            },
92            "resource": {
93              "type": "string",
94              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
95            },
96            "resource_slug": {
97              "type": "string",
98              "description": "This indicate the resource id where this custom field value is assosiated."
99            },
100            "type": {
101              "type": "string",
102              "description": "This is field_type of the custom field definition. Its non-editable",
103              "enum": [
104                "string_single_line",
105                "string_multi_line",
106                "dropdown",
107                "integer",
108                "float_type",
109                "boolean_type",
110                "date",
111                "datetime",
112                "json",
113                "file",
114                "url",
115                "metaobject",
116                "product"
117              ]
118            },
119            "multi_value": {
120              "type": "boolean",
121              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
122            },
123            "company_id": {
124              "type": "string",
125              "description": "This is company id where this custom fields created."
126            },
127            "application_id": {
128              "type": "string",
129              "description": "This is application id where this custom fields created."
130            },
131            "value": {
132              "type": "array",
133              "items": {
134                "type": [
135                  "string",
136                  "number",
137                  "object",
138                  "boolean"
139                ]
140              },
141              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
142            }
143          },
144          "required": [
145            "id",
146            "namespace",
147            "slug",
148            "resource",
149            "resource_slug",
150            "type",
151            "multi_value",
152            "company_id",
153            "application_id",
154            "value"
155          ]
156        }
157      ]
158    }
159  }
160}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.9097f265-5999-409c-b9c1-69cac2e8561a"
5    ],
6    "name": "customfields",
7    "type": "bag-update",
8    "version": "1",
9    "created_timestamp": 1712058945287,
10    "id": "3FAzwM7dMJENtA6gXZc0O581iY9WyePe0w5RL5GFVkE=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64aed377b1fd04565d0dff30",
16  "contains": [
17    "0"
18  ],
19  "payload": [
20    {
21      "id": "660bf2410b27788daa92d063",
22      "namespace": "custom",
23      "slug": "bag-size",
24      "resource": "bag",
25      "resource_slug": "142871",
26      "type": "string_single_line",
27      "multi_value": false,
28      "company_id": "1",
29      "application_id": "64aed377b1fd04565d0dff30",
30      "invalid_value_errors": [],
31      "has_invalid_values": false,
32      "value": [
33        "XL"
34      ]
35    }
36  ]
37}

application/customfields/coupon-update/v1

This event is triggered when a custom field from Coupon 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
array of Undefined Type
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": "array",
76      "items": [
77        {
78          "type": "object",
79          "properties": {
80            "id": {
81              "type": "string",
82              "description": "Uniquely generated mongoId of custom field and its not editable."
83            },
84            "namespace": {
85              "type": "string",
86              "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
91            },
92            "resource": {
93              "type": "string",
94              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
95            },
96            "resource_slug": {
97              "type": "string",
98              "description": "This indicate the resource id where this custom field value is assosiated."
99            },
100            "type": {
101              "type": "string",
102              "description": "This is field_type of the custom field definition. Its non-editable",
103              "enum": [
104                "string_single_line",
105                "string_multi_line",
106                "dropdown",
107                "integer",
108                "float_type",
109                "boolean_type",
110                "date",
111                "datetime",
112                "json",
113                "file",
114                "url",
115                "metaobject",
116                "product"
117              ]
118            },
119            "multi_value": {
120              "type": "boolean",
121              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
122            },
123            "company_id": {
124              "type": "string",
125              "description": "This is company id where this custom fields created."
126            },
127            "application_id": {
128              "type": "string",
129              "description": "This is application id where this custom fields created."
130            },
131            "value": {
132              "type": "array",
133              "items": {
134                "type": [
135                  "string",
136                  "number",
137                  "object",
138                  "boolean"
139                ]
140              },
141              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
142            }
143          },
144          "required": [
145            "id",
146            "namespace",
147            "slug",
148            "resource",
149            "resource_slug",
150            "type",
151            "multi_value",
152            "company_id",
153            "application_id",
154            "value"
155          ]
156        }
157      ]
158    }
159  }
160}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.18d15786-e5b3-4844-ae4a-8020489a0c4f"
5    ],
6    "name": "customfields",
7    "type": "coupon-update",
8    "version": "1",
9    "created_timestamp": 1712727982395,
10    "id": "vEFzDaUz5s+r6e9R5LHJLiAc0t7WSVXeWgAX2oGc5n4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 2,
15  "application_id": "64ba6650932a416fb67557fa",
16  "contains": [
17    "0"
18  ],
19  "payload": [
20    {
21      "id": "661627ae70004e45927be0dc",
22      "namespace": "custom",
23      "slug": "testing-custom-10apr1",
24      "resource": "coupon",
25      "resource_slug": "65ceff828856b87622cf05e6",
26      "type": "integer",
27      "multi_value": false,
28      "company_id": "2",
29      "application_id": "64ba6650932a416fb67557fa",
30      "invalid_value_errors": [],
31      "has_invalid_values": false,
32      "value": [
33        100424
34      ]
35    }
36  ]
37}

application/customfields/product-update/v1

This event is triggered when a custom field from product 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
array of Undefined Type
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": "array",
76      "items": [
77        {
78          "type": "object",
79          "properties": {
80            "id": {
81              "type": "string",
82              "description": "Uniquely generated mongoId of custom field and its not editable."
83            },
84            "namespace": {
85              "type": "string",
86              "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
91            },
92            "resource": {
93              "type": "string",
94              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
95            },
96            "resource_slug": {
97              "type": "string",
98              "description": "This indicate the resource id where this custom field value is assosiated."
99            },
100            "type": {
101              "type": "string",
102              "description": "This is field_type of the custom field definition. Its non-editable",
103              "enum": [
104                "string_single_line",
105                "string_multi_line",
106                "dropdown",
107                "integer",
108                "float_type",
109                "boolean_type",
110                "date",
111                "datetime",
112                "json",
113                "file",
114                "url",
115                "metaobject",
116                "product"
117              ]
118            },
119            "multi_value": {
120              "type": "boolean",
121              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
122            },
123            "company_id": {
124              "type": "string",
125              "description": "This is company id where this custom fields created."
126            },
127            "application_id": {
128              "type": "string",
129              "description": "This is application id where this custom fields created."
130            },
131            "value": {
132              "type": "array",
133              "items": {
134                "type": [
135                  "string",
136                  "number",
137                  "object",
138                  "boolean"
139                ]
140              },
141              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
142            }
143          },
144          "required": [
145            "id",
146            "namespace",
147            "slug",
148            "resource",
149            "resource_slug",
150            "type",
151            "multi_value",
152            "company_id",
153            "application_id",
154            "value"
155          ]
156        }
157      ]
158    }
159  }
160}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.48101caf-a019-422b-b8b9-aa9a92f06d27"
5    ],
6    "name": "customfields",
7    "type": "product-update",
8    "version": "1",
9    "created_timestamp": 1712140606057,
10    "id": "sirbb6tOIp0Zbe6/I0ATl84W/b5p4BpBq9wEa8d0JWE=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64aed377b1fd04565d0dff30",
16  "contains": [
17    "0"
18  ],
19  "payload": [
20    {
21      "id": "660d313e055b4743fab5d543",
22      "namespace": "custom",
23      "slug": "product-name",
24      "resource": "product",
25      "resource_slug": "7653745",
26      "type": "string_multi_line",
27      "multi_value": true,
28      "company_id": "1",
29      "application_id": "64aed377b1fd04565d0dff30",
30      "invalid_value_errors": [],
31      "has_invalid_values": false,
32      "value": [
33        "some test description hdsakhd sad sajhd sahd ksaj dklasjhd kjaskd hkdh skdksa hkashd kla"
34      ]
35    }
36  ]
37}

application/customfields/promotion-update/v1

This event is triggered when a custom field from promotion 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
array of Undefined Type
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": "array",
76      "items": [
77        {
78          "type": "object",
79          "properties": {
80            "id": {
81              "type": "string",
82              "description": "Uniquely generated mongoId of custom field and its not editable."
83            },
84            "namespace": {
85              "type": "string",
86              "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
91            },
92            "resource": {
93              "type": "string",
94              "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
95            },
96            "resource_slug": {
97              "type": "string",
98              "description": "This indicate the resource id where this custom field value is assosiated."
99            },
100            "type": {
101              "type": "string",
102              "description": "This is field_type of the custom field definition. Its non-editable",
103              "enum": [
104                "string_single_line",
105                "string_multi_line",
106                "dropdown",
107                "integer",
108                "float_type",
109                "boolean_type",
110                "date",
111                "datetime",
112                "json",
113                "file",
114                "url",
115                "metaobject",
116                "product"
117              ]
118            },
119            "multi_value": {
120              "type": "boolean",
121              "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
122            },
123            "company_id": {
124              "type": "string",
125              "description": "This is company id where this custom fields created."
126            },
127            "application_id": {
128              "type": "string",
129              "description": "This is application id where this custom fields created."
130            },
131            "value": {
132              "type": "array",
133              "items": {
134                "type": [
135                  "string",
136                  "number",
137                  "object",
138                  "boolean"
139                ]
140              },
141              "description": "This is array of values of custom fields. if multi value false then it has only single value in array. and in case of json this is json object."
142            }
143          },
144          "required": [
145            "id",
146            "namespace",
147            "slug",
148            "resource",
149            "resource_slug",
150            "type",
151            "multi_value",
152            "company_id",
153            "application_id",
154            "value"
155          ]
156        }
157      ]
158    }
159  }
160}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.729f1076-daba-4301-a8f1-a59fd9a8b508"
5    ],
6    "name": "customfields",
7    "type": "promotion-update",
8    "version": "1",
9    "created_timestamp": 1712728210264,
10    "id": "V7fT5xZ0FCevCGXikmOAEZU7cV5UgfmH6hIXplqEiy8=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 2,
15  "application_id": "64ba6650932a416fb67557fa",
16  "contains": [
17    "0"
18  ],
19  "payload": [
20    {
21      "id": "661628921bd71b47964c56d7",
22      "namespace": "custom",
23      "slug": "testing-custom-promotion-10apr2",
24      "resource": "promotion",
25      "resource_slug": "65671d9768a30daa23c5eab4",
26      "type": "string_single_line",
27      "multi_value": false,
28      "company_id": "2",
29      "application_id": "64ba6650932a416fb67557fa",
30      "invalid_value_errors": [],
31      "has_invalid_values": false,
32      "value": [
33        "test"
34      ]
35    }
36  ]
37}

Customobject definition

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

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

application/customobject_definition/create/v1

This event is triggered when a customobject definition 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
id
string
Required
Uniquely generated id of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
company_id
string
The id of the company where the field is created
application_id
string
The id of the application where the field is created
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "description": "This indicates all the custom field definitions part of the custom object",
100          "items": [
101            {
102              "type": "object",
103              "properties": {
104                "resource": {
105                  "type": "string",
106                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
107                },
108                "name": {
109                  "type": "string",
110                  "description": "Name of the custom fields. Its editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "type": {
121                  "type": "string",
122                  "description": "This is field_type of the custom field definition. Its non-editable"
123                },
124                "multi_value": {
125                  "type": "boolean",
126                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
127                },
128                "company_id": {
129                  "type": "string",
130                  "description": "This is company id where this custom fields created."
131                },
132                "application_id": {
133                  "type": "string",
134                  "description": "This is application id where this custom fields created."
135                },
136                "required": {
137                  "type": "boolean",
138                  "description": "This indicates whether the field is required or not"
139                },
140                "is_deleted": {
141                  "type": "boolean",
142                  "description": "This indicates that this custom fields definition is deleted or not."
143                }
144              },
145              "required": [
146                "resource",
147                "name",
148                "slug",
149                "type",
150                "company_id",
151                "application_id"
152              ]
153            }
154          ]
155        }
156      },
157      "required": [
158        "id",
159        "name",
160        "slug",
161        "field_definitions"
162      ]
163    }
164  }
165}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.15001f29-4fdb-4e2e-aa60-14613bc5d2f5"
5    ],
6    "name": "customobject_definition",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711213321865,
10    "id": "4kOMIhI2F3rqDMbMxSf+nl3gwtGcfZFW5H5HXGPRy7k=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "type",
20    "description",
21    "company_id",
22    "application_id",
23    "field_definitions"
24  ],
25  "payload": {
26    "id": "65ff0b09cd286b467dcae289",
27    "name": "kafka app test object",
28    "type": "kafka-app-test-object",
29    "slug": "kafka-app-test-object",
30    "description": "kafka app test object",
31    "company_id": "1",
32    "application_id": "64c00b72c07acacc1357503b",
33    "field_definitions": [
34      {
35        "resource": "metaobject",
36        "name": "kafka app test object single",
37        "namespace": "kafka-app-test-object",
38        "key": "kafka-app-test-object-single",
39        "slug": "kafka-app-test-object-single",
40        "description": "",
41        "type": "string_single_line",
42        "multi_value": true,
43        "validations": [],
44        "company_id": "1",
45        "application_id": "64c00b72c07acacc1357503b",
46        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
47        "required": true,
48        "is_deleted": false,
49        "id": "65ff0b09cd286b467dcae28c"
50      },
51      {
52        "resource": "metaobject",
53        "name": "kafka app test object multi",
54        "namespace": "kafka-app-test-object",
55        "key": "kafka-app-test-object-multi",
56        "slug": "kafka-app-test-object-multi",
57        "description": "",
58        "type": "string_multi_line",
59        "multi_value": true,
60        "validations": [],
61        "company_id": "1",
62        "application_id": "64c00b72c07acacc1357503b",
63        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
64        "required": true,
65        "is_deleted": false,
66        "id": "65ff0b09cd286b467dcae28d"
67      }
68    ]
69  }
70}

application/customobject_definition/delete/v1

This event is triggered when a customobject definition 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
id
string
Required
Uniquely generated id of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
company_id
string
The id of the company where the field is created
application_id
string
The id of the application where the field is created
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "description": "This indicates all the custom field definitions part of the custom object",
100          "items": [
101            {
102              "type": "object",
103              "properties": {
104                "resource": {
105                  "type": "string",
106                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
107                },
108                "name": {
109                  "type": "string",
110                  "description": "Name of the custom fields. Its editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "type": {
121                  "type": "string",
122                  "description": "This is field_type of the custom field definition. Its non-editable"
123                },
124                "multi_value": {
125                  "type": "boolean",
126                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
127                },
128                "company_id": {
129                  "type": "string",
130                  "description": "This is company id where this custom fields created."
131                },
132                "application_id": {
133                  "type": "string",
134                  "description": "This is application id where this custom fields created."
135                },
136                "required": {
137                  "type": "boolean",
138                  "description": "This indicates whether the field is required or not"
139                },
140                "is_deleted": {
141                  "type": "boolean",
142                  "description": "This indicates that this custom fields definition is deleted or not."
143                }
144              },
145              "required": [
146                "resource",
147                "name",
148                "slug",
149                "type",
150                "company_id",
151                "application_id"
152              ]
153            }
154          ]
155        }
156      },
157      "required": [
158        "id",
159        "name",
160        "slug",
161        "field_definitions"
162      ]
163    }
164  }
165}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.362874f3-39f9-4559-af45-777a63cba3bb"
5    ],
6    "name": "customobject_definition",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711213534784,
10    "id": "1cnMyJ8SM+swoNSF3LAMAPwQIVJLsNoV5j3QJDkqAqA=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "slug",
20    "description",
21    "company_id",
22    "application_id",
23    "display_name_key",
24    "field_definitions",
25    "is_deleted"
26  ],
27  "payload": {
28    "id": "65ff0b09cd286b467dcae289",
29    "name": "kafka app test object edited",
30    "slug": "kafka-app-test-object",
31    "description": "kafka app test object",
32    "company_id": "1",
33    "application_id": "64c00b72c07acacc1357503b",
34    "display_name_key": "",
35    "field_definitions": [
36      {
37        "id": "65ff0b09cd286b467dcae28d",
38        "resource": "metaobject",
39        "name": "kafka app test object multi",
40        "namespace": "kafka-app-test-object",
41        "slug": "kafka-app-test-object-multi",
42        "description": "",
43        "type": "string_multi_line",
44        "multi_value": true,
45        "validations": [],
46        "company_id": "1",
47        "application_id": "64c00b72c07acacc1357503b",
48        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
49        "required": true,
50        "is_deleted": false
51      },
52      {
53        "id": "65ff0b09cd286b467dcae28c",
54        "resource": "metaobject",
55        "name": "kafka app test object single",
56        "namespace": "kafka-app-test-object",
57        "slug": "kafka-app-test-object-single",
58        "description": "",
59        "type": "string_single_line",
60        "multi_value": true,
61        "validations": [],
62        "company_id": "1",
63        "application_id": "64c00b72c07acacc1357503b",
64        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
65        "required": true,
66        "is_deleted": false
67      }
68    ],
69    "is_deleted": true
70  }
71}

application/customobject_definition/update/v1

This event is triggered when a customobject definition 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
id
string
Required
Uniquely generated id of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
company_id
string
The id of the company where the field is created
application_id
string
The id of the application where the field is created
field_definitions
array of Undefined Type
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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated id of custom object definition and its not editable."
80        },
81        "name": {
82          "type": "string",
83          "description": "Name is use for the custom object definition name"
84        },
85        "slug": {
86          "type": "string",
87          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
88        },
89        "company_id": {
90          "type": "string",
91          "description": "The id of the company where the field is created"
92        },
93        "application_id": {
94          "type": "string",
95          "description": "The id of the application where the field is created"
96        },
97        "field_definitions": {
98          "type": "array",
99          "items": [
100            {
101              "type": "object",
102              "properties": {
103                "resource": {
104                  "type": "string",
105                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
106                },
107                "name": {
108                  "type": "string",
109                  "description": "Name of the custom fields. Its editable."
110                },
111                "namespace": {
112                  "type": "string",
113                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
114                },
115                "slug": {
116                  "type": "string",
117                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
118                },
119                "type": {
120                  "type": "string",
121                  "description": "This is field_type of the custom field definition. Its non-editable"
122                },
123                "multi_value": {
124                  "type": "boolean",
125                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
126                },
127                "company_id": {
128                  "type": "string",
129                  "description": "This is company id where this custom fields created."
130                },
131                "application_id": {
132                  "type": "string",
133                  "description": "The id of the application where this application is created"
134                },
135                "required": {
136                  "type": "boolean",
137                  "description": "This indicates whether the field is required or not"
138                },
139                "is_deleted": {
140                  "type": "boolean",
141                  "description": "This indicates that this custom fields definition is deleted or not."
142                }
143              },
144              "required": [
145                "resource",
146                "name",
147                "slug",
148                "type",
149                "company_id",
150                "application_id"
151              ]
152            }
153          ]
154        }
155      },
156      "required": [
157        "id",
158        "name",
159        "slug",
160        "field_definitions"
161      ]
162    }
163  }
164}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.79b4625e-928c-4c4c-ab6d-4bcc9e0f3dc6"
5    ],
6    "name": "customobject_definition",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711213382773,
10    "id": "vEKqvVohprDpJL1XjrQ59QM7iodqCbJcZO6/dO+LpCI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "name",
19    "slug",
20    "description",
21    "company_id",
22    "application_id",
23    "field_definitions"
24  ],
25  "payload": {
26    "id": "65ff0b09cd286b467dcae289",
27    "name": "kafka app test object edited",
28    "slug": "kafka-app-test-object",
29    "description": "kafka app test object",
30    "company_id": "1",
31    "application_id": "64c00b72c07acacc1357503b",
32    "field_definitions": [
33      {
34        "resource": "metaobject",
35        "name": "kafka app test object multi",
36        "namespace": "kafka-app-test-object",
37        "slug": "kafka-app-test-object-multi",
38        "type": "string_multi_line",
39        "description": "",
40        "multi_value": true,
41        "validations": [],
42        "company_id": "1",
43        "application_id": "64c00b72c07acacc1357503b",
44        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
45        "required": true
46      },
47      {
48        "resource": "metaobject",
49        "name": "kafka app test object single",
50        "namespace": "kafka-app-test-object",
51        "slug": "kafka-app-test-object-single",
52        "type": "string_single_line",
53        "description": "",
54        "multi_value": true,
55        "validations": [],
56        "company_id": "1",
57        "application_id": "64c00b72c07acacc1357503b",
58        "metaobject_definition_id": "65ff0b09cd286b467dcae289",
59        "required": true
60      }
61    ]
62  }
63}

Customobjects

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

Events
application/customobjects/create/v1
# This event is triggered when a custom object is created
application/customobjects/update/v1
# This event is triggered when a custom object is updated
application/customobjects/delete/v1
# This event is triggered when a custom object is deleted

application/customobjects/create/v1

This event is triggered when a custom object 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
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
application_id
string
Required
This is application id where this custom object created.
status
string
Required
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object under a custom object definition
definition_slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of Undefined Type
Required
This is list of custom fields values.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated mongoId of custom object and its not editable."
80        },
81        "company_id": {
82          "type": "string",
83          "description": "This is company id where this custom object created."
84        },
85        "application_id": {
86          "type": "string",
87          "description": "This is application id where this custom object created."
88        },
89        "status": {
90          "type": "string",
91          "description": "This is use for active/inactive status of custom object entry"
92        },
93        "slug": {
94          "type": "string",
95          "description": "This is a unique identifier for a custom object under a custom object definition"
96        },
97        "definition_slug": {
98          "type": "string",
99          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
100        },
101        "fields": {
102          "type": "array",
103          "description": "This is list of custom fields values.",
104          "items": [
105            {
106              "type": "object",
107              "properties": {
108                "id": {
109                  "type": "string",
110                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "resource": {
121                  "type": "string",
122                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
123                },
124                "type": {
125                  "type": "string",
126                  "description": "This is field_type of the custom field definition. Its non-editable"
127                },
128                "multi_value": {
129                  "type": "boolean",
130                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
131                },
132                "company_id": {
133                  "type": "string",
134                  "description": "This is company id where this custom fields created."
135                },
136                "application_id": {
137                  "type": "string",
138                  "description": "This is application id where this custom fields created."
139                },
140                "metaobject_definition_id": {
141                  "type": "string",
142                  "description": "This indicates the current custom field is associated with which custom object"
143                },
144                "value": {
145                  "type": "array",
146                  "items": {
147                    "type": [
148                      "string",
149                      "number",
150                      "object",
151                      "boolean"
152                    ]
153                  },
154                  "description": "This tells the values against the custom definition"
155                }
156              },
157              "required": [
158                "slug",
159                "type",
160                "value"
161              ]
162            }
163          ]
164        }
165      },
166      "required": [
167        "id",
168        "slug",
169        "company_id",
170        "application_id",
171        "status",
172        "definition_slug",
173        "fields"
174      ]
175    }
176  }
177}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.fb26b39a-ef97-4654-9ff4-d4dea2320727"
5    ],
6    "name": "customobjects",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711210308650,
10    "id": "HJWHJYjE2LzCI0M+1mR1RNHND7kqCRfxBOMHhp+UuR4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "company_id",
19    "application_id",
20    "status",
21    "slug",
22    "type",
23    "display_name",
24    "definition_id",
25    "fields"
26  ],
27  "payload": {
28    "id": "65feff44cd286b467dcae194",
29    "company_id": "1",
30    "application_id": "64c00b72c07acacc1357503b",
31    "status": "active",
32    "slug": "65feff44cd286b467dcae194",
33    "type": "tetsc1",
34    "display_name": "tetsc1 #65feff44cd286b467dcae194",
35    "fields": [
36      {
37        "id": "65feff44cd286b467dcae198",
38        "namespace": "tetsc1",
39        "slug": "tetsc1",
40        "resource": "metaobject",
41        "type": "string_single_line",
42        "multi_value": false,
43        "company_id": "1",
44        "application_id": "64c00b72c07acacc1357503b",
45        "invalid_value_errors": [],
46        "has_invalid_values": false,
47        "metaobject_definition_id": "65af838f9fb5333f5a966118",
48        "value": [
49          "tetsc1"
50        ]
51      }
52    ]
53  }
54}

application/customobjects/update/v1

This event is triggered when a custom object 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
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
application_id
string
Required
This is application id where this custom object created.
status
string
Required
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object under a custom object definition
definition_slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of Undefined Type
Required
This is list of custom fields values.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated mongoId of custom object and its not editable."
80        },
81        "company_id": {
82          "type": "string",
83          "description": "This is company id where this custom object created."
84        },
85        "application_id": {
86          "type": "string",
87          "description": "This is application id where this custom object created."
88        },
89        "status": {
90          "type": "string",
91          "description": "This is use for active/inactive status of custom object entry"
92        },
93        "slug": {
94          "type": "string",
95          "description": "This is a unique identifier for a custom object under a custom object definition"
96        },
97        "definition_slug": {
98          "type": "string",
99          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
100        },
101        "fields": {
102          "type": "array",
103          "description": "This is list of custom fields values.",
104          "items": [
105            {
106              "type": "object",
107              "properties": {
108                "id": {
109                  "type": "string",
110                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A its unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "resource": {
121                  "type": "string",
122                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
123                },
124                "type": {
125                  "type": "string",
126                  "description": "This is field_type of the custom field definition. Its non-editable"
127                },
128                "multi_value": {
129                  "type": "boolean",
130                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
131                },
132                "company_id": {
133                  "type": "string",
134                  "description": "This is company id where this custom fields created."
135                },
136                "application_id": {
137                  "type": "string",
138                  "description": "This is application id where this custom fields created."
139                },
140                "metaobject_definition_id": {
141                  "type": "string",
142                  "description": "This indicates the current custom field is associated with which custom object"
143                },
144                "value": {
145                  "type": "array",
146                  "items": {
147                    "type": [
148                      "string",
149                      "number",
150                      "object",
151                      "boolean"
152                    ]
153                  },
154                  "description": "This tells the values against the custom definition"
155                }
156              },
157              "required": [
158                "slug",
159                "type",
160                "value"
161              ]
162            }
163          ]
164        }
165      },
166      "required": [
167        "id",
168        "company_id",
169        "application_id",
170        "status",
171        "slug",
172        "definition_slug",
173        "fields"
174      ]
175    }
176  }
177}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.55ba1bfa-af1d-4cc4-9004-8be5543f4ca6"
5    ],
6    "name": "customobjects",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711212505130,
10    "id": "QvqT1iYYAngtpYpd5UZu1amKDg1TVa9d059j58IFv+Y=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "company_id",
19    "application_id",
20    "status",
21    "slug",
22    "is_deleted",
23    "display_name",
24    "fields"
25  ],
26  "payload": {
27    "id": "65feff44cd286b467dcae194",
28    "company_id": "1",
29    "application_id": "64c00b72c07acacc1357503b",
30    "status": "active",
31    "type": "tetsc1",
32    "definition_slug": "tetsc1",
33    "is_deleted": false,
34    "display_name": "tetsc1 #65feff44cd286b467dcae194",
35    "slug": "65feff44cd286b467dcae194",
36    "fields": [
37      {
38        "id": "65feff44cd286b467dcae198",
39        "namespace": "tetsc1",
40        "slug": "tetsc1",
41        "resource": "metaobject",
42        "type": "string_single_line",
43        "multi_value": false,
44        "company_id": "1",
45        "application_id": "64c00b72c07acacc1357503b",
46        "invalid_value_errors": [],
47        "has_invalid_values": false,
48        "metaobject_definition_id": "65af838f9fb5333f5a966118",
49        "value": [
50          "tetsc1 edited"
51        ]
52      }
53    ]
54  }
55}

application/customobjects/delete/v1

This event is triggered when a custom object 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
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
application_id
string
Required
This is application id where this custom object created.
status
string
Required
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object under a custom object definition
definition_slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of Undefined Type
Required
This is list of custom fields values.
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload",
8    "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      "properties": {
77        "id": {
78          "type": "string",
79          "description": "Uniquely generated mongoId of custom object and its not editable."
80        },
81        "company_id": {
82          "type": "string",
83          "description": "This is company id where this custom object created."
84        },
85        "application_id": {
86          "type": "string",
87          "description": "This is application id where this custom object created."
88        },
89        "status": {
90          "type": "string",
91          "description": "This is use for active/inactive status of custom object entry"
92        },
93        "slug": {
94          "type": "string",
95          "description": "This is a unique identifier for a custom object under a custom object definition"
96        },
97        "definition_slug": {
98          "type": "string",
99          "description": "A unique identifier for the custom object definition. Its required and will not be modified once created."
100        },
101        "fields": {
102          "type": "array",
103          "description": "This is list of custom fields values.",
104          "items": [
105            {
106              "type": "object",
107              "properties": {
108                "id": {
109                  "type": "string",
110                  "description": "Uniquely generated mongoId of custom field entry and its not editable."
111                },
112                "namespace": {
113                  "type": "string",
114                  "description": "namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable."
115                },
116                "slug": {
117                  "type": "string",
118                  "description": "A its unique identifier for the custom fields definition. Its required and will not be modified once created."
119                },
120                "resource": {
121                  "type": "string",
122                  "description": "Resource indicate that this custom field is assosiated with this resource.This is non-editable"
123                },
124                "type": {
125                  "type": "string",
126                  "description": "This is field_type of the custom field definition. Its non-editable"
127                },
128                "multi_value": {
129                  "type": "boolean",
130                  "description": "This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value."
131                },
132                "company_id": {
133                  "type": "string",
134                  "description": "This is company id where this custom fields created."
135                },
136                "application_id": {
137                  "type": "string",
138                  "description": "This is application id where this custom fields created."
139                },
140                "metaobject_definition_id": {
141                  "type": "string",
142                  "description": "This indicates the current custom field is associated with which custom object"
143                },
144                "value": {
145                  "type": "array",
146                  "items": {
147                    "type": [
148                      "string",
149                      "number",
150                      "object",
151                      "boolean"
152                    ]
153                  },
154                  "description": "This tells the values against the custom definition"
155                }
156              },
157              "required": [
158                "slug",
159                "type",
160                "value"
161              ]
162            }
163          ]
164        }
165      },
166      "required": [
167        "id",
168        "company_id",
169        "application_id",
170        "status",
171        "slug",
172        "definition_slug",
173        "fields"
174      ]
175    }
176  }
177}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.55ba1bfa-af1d-4cc4-9004-8be5543f4ca6"
5    ],
6    "name": "customobjects",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711212505130,
10    "id": "QvqT1iYYAngtpYpd5UZu1amKDg1TVa9d059j58IFv+Y=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": "64c00b72c07acacc1357503b",
16  "contains": [
17    "id",
18    "company_id",
19    "application_id",
20    "status",
21    "slug",
22    "is_deleted",
23    "display_name",
24    "fields"
25  ],
26  "payload": {
27    "id": "65feff44cd286b467dcae194",
28    "company_id": "1",
29    "application_id": "64c00b72c07acacc1357503b",
30    "status": "active",
31    "type": "tetsc1",
32    "definition_slug": "tetsc1",
33    "is_deleted": false,
34    "display_name": "tetsc1 #65feff44cd286b467dcae194",
35    "slug": "65feff44cd286b467dcae194",
36    "fields": [
37      {
38        "id": "65feff44cd286b467dcae198",
39        "namespace": "tetsc1",
40        "slug": "tetsc1",
41        "resource": "metaobject",
42        "type": "string_single_line",
43        "multi_value": false,
44        "company_id": "1",
45        "application_id": "64c00b72c07acacc1357503b",
46        "invalid_value_errors": [],
47        "has_invalid_values": false,
48        "metaobject_definition_id": "65af838f9fb5333f5a966118",
49        "value": [
50          "tetsc1 edited"
51        ]
52      }
53    ]
54  }
55}

Details groups

This event will be generated when detail group is modified. Detail group represents a reusable set of attributes that are displayed in product description on product detail page.

Events
application/details_groups/create/v1
# This event is triggered when product detail group is created. This will be displayed in product description.
application/details_groups/delete/v1
# This event is triggered when product detail group is deleted. This will be displayed in product description.
application/details_groups/update/v1
# This event is triggered when product detail group is updated. This will be displayed in product description.

application/details_groups/create/v1

This event is triggered when product detail group is created. This will be displayed in product description.

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
details-groups
object
Required
Object containing information about a product detail group. This contains information displayed in product description.
Properties
is_default
boolean
Required
Is this a default detailed to be added in all product description.
slug
string
Required
A unique identifier for the details group.
is_active
boolean
Required
Specifies whether the details group is active and should be visible in descriptions.
priority
integer
Required
Defines the priority of this details group. Higher values mean it is displayed before other details in description.
attributes
array of object
Required
List of attributes associated with the details group.
Array of Properties
is_active
boolean
Required
Indicates if the attribute is active.
name
string
Required
Name of the attribute.
display_type
string
Required
Type of display used for this attribute (e.g., text, dropdown).
slug
string
Required
A unique identifier for the attribute.
key
string
Required
Key used for identifying the attribute in data processing.
priority
integer
Required
Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group.
name
string
Required
Name of the details group.
template_slugs
array of string
Required
List of unique string associated with any predefined template for the group.
app_id
string
Required
Identifier for the application this details group belongs to.
id
string
Required
Unique identifier for the details group.
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        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details group."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, dropdown)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute in data processing."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}
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    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

application/details_groups/delete/v1

This event is triggered when product detail group is deleted. This will be displayed in product description.

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
details-groups
object
Required
Object containing information about a product detail group. This contains information displayed in product description.
Properties
is_default
boolean
Required
Is this a default detailed to be added in all product description.
slug
string
Required
A unique identifier for the details.
is_active
boolean
Required
Specifies whether the details group is active and should be visible in descriptions.
priority
integer
Required
Defines the priority of this details group. Higher values mean it is displayed before other details in description.
attributes
array of object
Required
List of attributes associated with the details group.
Array of Properties
is_active
boolean
Required
Indicates if the attribute is active.
name
string
Required
Name of the attribute.
display_type
string
Required
Type of display used for this attribute (e.g., text, dropdown).
slug
string
Required
A unique identifier for the attribute.
key
string
Required
Key used for identifying the attribute in data processing.
priority
integer
Required
Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group.
name
string
Required
Name of the details group.
template_slugs
array of string
Required
List of unique string associated with any predefined template for the group.
app_id
string
Required
Identifier for the application this details group belongs to.
id
string
Required
Unique identifier for the details group.
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        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, dropdown)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute in data processing."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}
Payload Example
1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "details-groups"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1708644940476,
10    "id": "gFx0LWac2FBTIAmnrwlX05p0cDVbAc02TU46sTOepIQ=",
11    "name": "details-groups",
12    "trace_id": [
13      "silverbolt.16bfae2e-d1db-11ee-ae64-b66edc95121c"
14    ],
15    "type": "create",
16    "version": "1"
17  },
18  "payload": {
19    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

application/details_groups/update/v1

This event is triggered when product detail group is updated. This will be displayed in product description.

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
details-groups
object
Required
Object containing information about a product detail group. This contains information displayed in product description.
Properties
is_default
boolean
Required
Is this a default detailed to be added in all product description.
slug
string
Required
A unique identifier for the details group.
is_active
boolean
Required
Specifies whether the details group is active and should be visible in descriptions.
priority
integer
Required
Defines the priority of this details group. Higher values mean it is displayed before other details in description.
attributes
array of object
Required
List of attributes associated with the details group.
Array of Properties
is_active
boolean
Required
Indicates if the attribute is active.
name
string
Required
Name of the attribute.
display_type
string
Required
Type of display used for this attribute (e.g., text, html or other).
slug
string
Required
A unique identifier for the attribute.
key
string
Required
Key used for identifying the attribute from the product data. This can be different from slug as this is a field present in data.
priority
integer
Required
Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group.
name
string
Required
Name of the details group.
template_slugs
array of string
Required
List of unique string associated with any predefined template for the group.
app_id
string
Required
Identifier for the application id this details group belongs to.
id
string
Required
Unique identifier for the details group.
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        "details-groups"
78      ],
79      "properties": {
80        "details-groups": {
81          "type": "object",
82          "description": "Object containing information about a product detail group. This contains information displayed in product description.",
83          "properties": {
84            "is_default": {
85              "type": "boolean",
86              "description": "Is this a default detailed to be added in all product description."
87            },
88            "slug": {
89              "type": "string",
90              "description": "A unique identifier for the details group."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Specifies whether the details group is active and should be visible in descriptions."
95            },
96            "priority": {
97              "type": "integer",
98              "description": "Defines the priority of this details group. Higher values mean it is displayed before other details in description."
99            },
100            "attributes": {
101              "type": "array",
102              "description": "List of attributes associated with the details group.",
103              "items": {
104                "type": "object",
105                "properties": {
106                  "is_active": {
107                    "type": "boolean",
108                    "description": "Indicates if the attribute is active."
109                  },
110                  "name": {
111                    "type": "string",
112                    "description": "Name of the attribute."
113                  },
114                  "display_type": {
115                    "type": "string",
116                    "description": "Type of display used for this attribute (e.g., text, html or other)."
117                  },
118                  "slug": {
119                    "type": "string",
120                    "description": "A unique identifier for the attribute."
121                  },
122                  "key": {
123                    "type": "string",
124                    "description": "Key used for identifying the attribute from the product data. This can be different from slug as this is a field present in data."
125                  },
126                  "priority": {
127                    "type": "integer",
128                    "description": "Defines the order for the attribute withing a group. Higher values indicate that it needs to placed on top in the group."
129                  }
130                },
131                "required": [
132                  "is_active",
133                  "name",
134                  "display_type",
135                  "slug",
136                  "key",
137                  "priority"
138                ]
139              }
140            },
141            "name": {
142              "type": "string",
143              "description": "Name of the details group."
144            },
145            "template_slugs": {
146              "type": "array",
147              "description": "List of unique string associated with any predefined template for the group.",
148              "items": {
149                "type": "string"
150              }
151            },
152            "app_id": {
153              "type": "string",
154              "description": "Identifier for the application id this details group belongs to."
155            },
156            "id": {
157              "type": "string",
158              "description": "Unique identifier for the details group."
159            }
160          },
161          "required": [
162            "is_default",
163            "slug",
164            "is_active",
165            "priority",
166            "attributes",
167            "name",
168            "template_slugs",
169            "app_id",
170            "id"
171          ]
172        }
173      }
174    }
175  }
176}
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    "details-groups": {
20      "is_default": false,
21      "slug": "details-groups",
22      "is_active": true,
23      "priority": 1,
24      "attributes": [
25        {
26          "is_active": true,
27          "name": "Color",
28          "display_type": "dropdown",
29          "slug": "color",
30          "key": "color_key",
31          "priority": 5
32        }
33      ],
34      "name": "Basic details",
35      "template_slugs": [
36        "test_slug"
37      ],
38      "app_id": "12121232efef",
39      "id": "67f9876abc32"
40    }
41  }
42}

Discount

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

Events
application/discount/create/v1
# this event is triggered when discount is created
application/discount/end/v1
# this event is triggered when discount is ended
application/discount/start/v1
# this event is triggered when discount is started
application/discount/update/v1
# this event is triggered when discount is updated

application/discount/create/v1

this event is triggered when discount 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
discount
object
Required
Properties
job_type
string
Required
Used to determines type of discount.
name
string
Required
The name of the discount
file_path
string
The file path of the uploaded file used to create the discount, particularly applicable for custom discounts.
is_active
boolean
Required
Whether the discount is currently active or not
discount_type
string
Required
The type of the discount
discount_level
string
Required
The level at which the discount will be applicable
company_id
integer
Required
The identifier of the company for which the discount was created
zone_ids
array of Undefined Type
The discount will be applied to the products associated with the delivery zones listed.
app_ids
array of string
Required
The discount will be applied to the products associated with the app IDs listed.
validity
object
Required
The duration during which the discount is applicable to the products.
Properties
start
string
Required
The commencement time of the discount period for the products.
end
string
Required
The conclusion time of the discount period for the products.
created_by
object
Username of the user who created the discount
Properties
username
string
Required
Username of the user who created the discount
user_id
string
Required
User ID of the user who created the discount
modified_by
object
The user who last modified the discount.
Properties
username
string
Required
Username of the user who last modified the discount
user_id
string
Required
User ID of the user who last modified the discount
created_on
string
The date and time when the discount was created
modified_on
string
The date and time when the discount was last modified
brand_ids
array of integer
The discount will be applied to the products associated with the brand IDs listed.
discount_meta
object
Holds information about the discount countdown timer displayed to the user
Properties
timer
boolean
Required
This field determines whether the countdown timer is visible or hidden. A value of true means the timer is displayed, while false means it's hidden.
hours
integer
Required
The time in hours before the discount ends when the countdown timer should start.
minutes
integer
Required
The time in minutes before the discount ends when the countdown timer should start.
id
string
Required
The discount.id field contains a unique identifier of type ObjectId assigned to the discount.
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      "properties": {
77        "discount": {
78          "type": "object",
79          "properties": {
80            "job_type": {
81              "type": "string",
82              "description": "Used to determines type of discount."
83            },
84            "name": {
85              "type": "string",
86              "description": "The name of the discount"
87            },
88            "file_path": {
89              "type": "string",
90              "description": "The file path of the uploaded file used to create the discount, particularly applicable for custom discounts."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Whether the discount is currently active or not"
95            },
96            "discount_type": {
97              "type": "string",
98              "description": "The type of the discount"
99            },
100            "discount_level": {
101              "type": "string",
102              "description": "The level at which the discount will be applicable"
103            },
104            "company_id": {
105              "type": "integer",
106              "description": "The identifier of the company for which the discount was created"
107            },
108            "zone_ids": {
109              "type": "array",
110              "items": [
111                {
112                  "type": "string"
113                }
114              ],
115              "description": "The discount will be applied to the products associated with the delivery zones listed."
116            },
117            "app_ids": {
118              "type": "array",
119              "items": {
120                "type": "string"
121              },
122              "description": "The discount will be applied to the products associated with the app IDs listed."
123            },
124            "validity": {
125              "type": "object",
126              "properties": {
127                "start": {
128                  "type": "string",
129                  "description": "The commencement time of the discount period for the products."
130                },
131                "end": {
132                  "type": "string",
133                  "description": "The conclusion time of the discount period for the products."
134                }
135              },
136              "required": [
137                "start",
138                "end"
139              ],
140              "description": "The duration during which the discount is applicable to the products."
141            },
142            "created_by": {
143              "type": "object",
144              "properties": {
145                "username": {
146                  "type": "string",
147                  "description": "Username of the user who created the discount"
148                },
149                "user_id": {
150                  "type": "string",
151                  "description": "User ID of the user who created the discount"
152                }
153              },
154              "required": [
155                "username",
156                "user_id"
157              ],
158              "description": "Username of the user who created the discount"
159            },
160            "modified_by": {
161              "type": "object",
162              "properties": {
163                "username": {
164                  "type": "string",
165                  "description": "Username of the user who last modified the discount"
166                },
167                "user_id": {
168                  "type": "string",
169                  "description": "User ID of the user who last modified the discount"
170                }
171              },
172              "required": [
173                "username",
174                "user_id"
175              ],
176              "description": "The user who last modified the discount."
177            },
178            "created_on": {
179              "type": "string",
180              "description": "The date and time when the discount was created"
181            },
182            "modified_on": {
183              "type": "string",
184              "description": "The date and time when the discount was last modified"
185            },
186            "brand_ids": {
187              "type": "array",
188              "items": {
189                "type": "integer"
190              },
191              "description": "The discount will be applied to the products associated with the brand IDs listed."
192            },
193            "discount_meta": {
194              "type": "object",
195              "properties": {
196                "timer": {
197                  "type": "boolean",
198                  "description": "This field determines whether the countdown timer is visible or hidden.  A value of true means the timer is displayed, while false means it's hidden."
199                },
200                "hours": {
201                  "type": "integer",
202                  "description": "The time in hours before the discount ends when the countdown timer should start."
203                },
204                "minutes": {
205                  "type": "integer",
206                  "description": "The time in minutes before the discount ends when the countdown timer should start."
207                }
208              },
209              "required": [
210                "timer",
211                "hours",
212                "minutes"
213              ],
214              "description": "Holds information about the discount countdown timer displayed to the user"
215            },
216            "id": {
217              "type": "string",
218              "description": "The discount.id field contains a unique identifier of type ObjectId assigned to the discount."
219            }
220          },
221          "required": [
222            "job_type",
223            "name",
224            "is_active",
225            "discount_type",
226            "discount_level",
227            "company_id",
228            "app_ids",
229            "validity",
230            "id"
231          ],
232          "description": ""
233        }
234      },
235      "required": [
236        "discount"
237      ]
238    }
239  }
240}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "galvatron.817daf90-f274-11ee-9d9d-7d9d01b806ed"
5    ],
6    "name": "discount",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712229269769,
10    "id": "hOv4gBHXsGfBXGq+EbR1Ke0RgOFG1F4HPF4U2Xe7RwU=",
11    "category": "application"
12  },
13  "company_id": 4460,
14  "application_id": "6461f4dfbdbb9e66f912ca09",
15  "contains": [
16    "discount"
17  ],
18  "payload": {
19    "discount": {
20      "job_type": "app|brand|inventory",
21      "name": "INC.5 DISCOUNT 30% 4 APR",
22      "file_path": "/company/4460/self/documents/product-import/free/original/Y9CNHYeN_-discout_sku_sample-(30).xlsx",
23      "is_active": true,
24      "discount_type": "percentage",
25      "value": null,
26      "discount_meta": {
27        "timer": false,
28        "hours": 0,
29        "minutes": 0
30      },
31      "discount_level": "application",
32      "company_id": 4460,
33      "zone_ids": [],
34      "app_ids": [
35        "6461f4dfbdbb9e66f912ca09"
36      ],
37      "validity": {
38        "start": "2024-04-04T11:20:05.000Z",
39        "end": "2024-06-29T18:30:00.000Z"
40      },
41      "created_by": {
42        "username": "test_example_com_12345",
43        "user_id": "23125331"
44      },
45      "modified_by": {
46        "username": "test_example_com_12345",
47        "user_id": "23125331"
48      },
49      "created_on": "2024-04-04T11:14:29.718Z",
50      "modified_on": "2024-04-04T11:14:29.748Z",
51      "id": "660e8b958fe23bcea999b88c"
52    }
53  }
54}

application/discount/end/v1

this event is triggered when discount is ended

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
discount
object
Required
Properties
job_type
string
Required
Used to determines type of discount.
name
string
Required
The name of the discount
file_path
string
The file path of the uploaded file used to create the discount, particularly applicable for custom discounts.
is_active
boolean
Required
Whether the discount is currently active or not
discount_type
string
Required
The type of the discount
discount_level
string
Required
The level at which the discount will be applicable
company_id
integer
Required
The identifier of the company for which the discount was created
zone_ids
array of Undefined Type
The discount will be applied to the products associated with the delivery zones listed.
app_ids
array of string
Required
The discount will be applied to the products associated with the app IDs listed.
validity
object
Required
The duration during which the discount is applicable to the products.
Properties
start
string
Required
The commencement time of the discount period for the products.
end
string
Required
The conclusion time of the discount period for the products.
created_by
object
Username of the user who created the discount
Properties
username
string
Required
Username of the user who created the discount
user_id
string
Required
User ID of the user who created the discount
modified_by
object
The user who last modified the discount.
Properties
username
string
Required
Username of the user who last modified the discount
user_id
string
Required
User ID of the user who last modified the discount
created_on
string
The date and time when the discount was created
modified_on
string
The date and time when the discount was last modified
brand_ids
array of integer
The discount will be applied to the products associated with the brand IDs listed.
discount_meta
object
Holds information about the discount countdown timer displayed to the user
Properties
timer
boolean
Required
This field determines whether the countdown timer is visible or hidden. A value of true means the timer is displayed, while false means it's hidden.
hours
integer
Required
The time in hours before the discount ends when the countdown timer should start.
minutes
integer
Required
The time in minutes before the discount ends when the countdown timer should start.
id
string
Required
The discount.id field contains a unique identifier of type ObjectId assigned to the discount.
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      "properties": {
77        "discount": {
78          "type": "object",
79          "properties": {
80            "job_type": {
81              "type": "string",
82              "description": "Used to determines type of discount."
83            },
84            "name": {
85              "type": "string",
86              "description": "The name of the discount"
87            },
88            "file_path": {
89              "type": "string",
90              "description": "The file path of the uploaded file used to create the discount, particularly applicable for custom discounts."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Whether the discount is currently active or not"
95            },
96            "discount_type": {
97              "type": "string",
98              "description": "The type of the discount"
99            },
100            "discount_level": {
101              "type": "string",
102              "description": "The level at which the discount will be applicable"
103            },
104            "company_id": {
105              "type": "integer",
106              "description": "The identifier of the company for which the discount was created"
107            },
108            "zone_ids": {
109              "type": "array",
110              "items": [
111                {
112                  "type": "string"
113                }
114              ],
115              "description": "The discount will be applied to the products associated with the delivery zones listed."
116            },
117            "app_ids": {
118              "type": "array",
119              "items": {
120                "type": "string"
121              },
122              "description": "The discount will be applied to the products associated with the app IDs listed."
123            },
124            "validity": {
125              "type": "object",
126              "properties": {
127                "start": {
128                  "type": "string",
129                  "description": "The commencement time of the discount period for the products."
130                },
131                "end": {
132                  "type": "string",
133                  "description": "The conclusion time of the discount period for the products."
134                }
135              },
136              "required": [
137                "start",
138                "end"
139              ],
140              "description": "The duration during which the discount is applicable to the products."
141            },
142            "created_by": {
143              "type": "object",
144              "properties": {
145                "username": {
146                  "type": "string",
147                  "description": "Username of the user who created the discount"
148                },
149                "user_id": {
150                  "type": "string",
151                  "description": "User ID of the user who created the discount"
152                }
153              },
154              "required": [
155                "username",
156                "user_id"
157              ],
158              "description": "Username of the user who created the discount"
159            },
160            "modified_by": {
161              "type": "object",
162              "properties": {
163                "username": {
164                  "type": "string",
165                  "description": "Username of the user who last modified the discount"
166                },
167                "user_id": {
168                  "type": "string",
169                  "description": "User ID of the user who last modified the discount"
170                }
171              },
172              "required": [
173                "username",
174                "user_id"
175              ],
176              "description": "The user who last modified the discount."
177            },
178            "created_on": {
179              "type": "string",
180              "description": "The date and time when the discount was created"
181            },
182            "modified_on": {
183              "type": "string",
184              "description": "The date and time when the discount was last modified"
185            },
186            "brand_ids": {
187              "type": "array",
188              "items": {
189                "type": "integer"
190              },
191              "description": "The discount will be applied to the products associated with the brand IDs listed."
192            },
193            "discount_meta": {
194              "type": "object",
195              "properties": {
196                "timer": {
197                  "type": "boolean",
198                  "description": "This field determines whether the countdown timer is visible or hidden.  A value of true means the timer is displayed, while false means it's hidden."
199                },
200                "hours": {
201                  "type": "integer",
202                  "description": "The time in hours before the discount ends when the countdown timer should start."
203                },
204                "minutes": {
205                  "type": "integer",
206                  "description": "The time in minutes before the discount ends when the countdown timer should start."
207                }
208              },
209              "required": [
210                "timer",
211                "hours",
212                "minutes"
213              ],
214              "description": "Holds information about the discount countdown timer displayed to the user"
215            },
216            "id": {
217              "type": "string",
218              "description": "The discount.id field contains a unique identifier of type ObjectId assigned to the discount."
219            }
220          },
221          "required": [
222            "job_type",
223            "name",
224            "is_active",
225            "discount_type",
226            "discount_level",
227            "company_id",
228            "app_ids",
229            "validity",
230            "id"
231          ],
232          "description": ""
233        }
234      },
235      "required": [
236        "discount"
237      ]
238    }
239  }
240}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "galvatron.029ac000-f247-11ee-8ebf-a5449eb2a343"
5    ],
6    "name": "discount",
7    "type": "end",
8    "version": "1",
9    "created_timestamp": 1712209729536,
10    "id": "MLbp0ah4hV/+HuBTZa2HYMOQeEPl6f4zd41xRRWVhng=",
11    "category": "application"
12  },
13  "company_id": 1202,
14  "application_id": "6266915e7dc67510e66c8b42",
15  "contains": [
16    "discount"
17  ],
18  "payload": {
19    "discount": {
20      "is_active": true,
21      "app_ids": [
22        "6266915e7dc67510e66c8b42"
23      ],
24      "name": "FLAT 50% OFF",
25      "job_type": "app|brand|inventory",
26      "discount_type": "percentage",
27      "discount_level": "application",
28      "company_id": 1202,
29      "validity": {
30        "start": "2022-06-15T07:25:43.185Z",
31        "end": "2023-07-01T18:25:00.000Z"
32      },
33      "value": 0,
34      "file_path": "/company/1202/self/documents/product-import/free/original/-ENdY7AHU-FYND-Discount-File-(01-Mar-23).xlsx",
35      "created_by": {
36        "username": "test_example_com_12345",
37        "user_id": "23259036"
38      },
39      "modified_by": {
40        "username": "test_example_com_12345",
41        "user_id": "23530585"
42      },
43      "created_on": "2022-06-15T07:11:09.831Z",
44      "modified_on": "2024-04-04T05:48:49.524Z",
45      "discount_meta": {
46        "timer": false,
47        "hours": 0,
48        "minutes": 0
49      },
50      "zone_ids": [],
51      "id": "62a9860dbbb01500073d98ba"
52    }
53  }
54}

application/discount/start/v1

this event is triggered when discount is started

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
discount
object
Required
Properties
job_type
string
Required
Used to determines type of discount.
name
string
Required
The name of the discount
file_path
string
The file path of the uploaded file used to create the discount, particularly applicable for custom discounts.
is_active
boolean
Required
Whether the discount is currently active or not
discount_type
string
Required
The type of the discount
discount_level
string
Required
The level at which the discount will be applicable
company_id
integer
Required
The identifier of the company for which the discount was created
zone_ids
array of Undefined Type
The discount will be applied to the products associated with the delivery zones listed.
app_ids
array of string
Required
The discount will be applied to the products associated with the app IDs listed.
validity
object
Required
The duration during which the discount is applicable to the products.
Properties
start
string
Required
The commencement time of the discount period for the products.
end
string
Required
The conclusion time of the discount period for the products.
created_by
object
Username of the user who created the discount
Properties
username
string
Required
Username of the user who created the discount
user_id
string
Required
User ID of the user who created the discount
modified_by
object
The user who last modified the discount.
Properties
username
string
Required
Username of the user who last modified the discount
user_id
string
Required
User ID of the user who last modified the discount
created_on
string
The date and time when the discount was created
modified_on
string
The date and time when the discount was last modified
brand_ids
array of integer
The discount will be applied to the products associated with the brand IDs listed.
discount_meta
object
Holds information about the discount countdown timer displayed to the user
Properties
timer
boolean
Required
This field determines whether the countdown timer is visible or hidden. A value of true means the timer is displayed, while false means it's hidden.
hours
integer
Required
The time in hours before the discount ends when the countdown timer should start.
minutes
integer
Required
The time in minutes before the discount ends when the countdown timer should start.
id
string
Required
The discount.id field contains a unique identifier of type ObjectId assigned to the discount.
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      "properties": {
77        "discount": {
78          "type": "object",
79          "properties": {
80            "job_type": {
81              "type": "string",
82              "description": "Used to determines type of discount."
83            },
84            "name": {
85              "type": "string",
86              "description": "The name of the discount"
87            },
88            "file_path": {
89              "type": "string",
90              "description": "The file path of the uploaded file used to create the discount, particularly applicable for custom discounts."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Whether the discount is currently active or not"
95            },
96            "discount_type": {
97              "type": "string",
98              "description": "The type of the discount"
99            },
100            "discount_level": {
101              "type": "string",
102              "description": "The level at which the discount will be applicable"
103            },
104            "company_id": {
105              "type": "integer",
106              "description": "The identifier of the company for which the discount was created"
107            },
108            "zone_ids": {
109              "type": "array",
110              "items": [
111                {
112                  "type": "string"
113                }
114              ],
115              "description": "The discount will be applied to the products associated with the delivery zones listed."
116            },
117            "app_ids": {
118              "type": "array",
119              "items": {
120                "type": "string"
121              },
122              "description": "The discount will be applied to the products associated with the app IDs listed."
123            },
124            "validity": {
125              "type": "object",
126              "properties": {
127                "start": {
128                  "type": "string",
129                  "description": "The commencement time of the discount period for the products."
130                },
131                "end": {
132                  "type": "string",
133                  "description": "The conclusion time of the discount period for the products."
134                }
135              },
136              "required": [
137                "start",
138                "end"
139              ],
140              "description": "The duration during which the discount is applicable to the products."
141            },
142            "created_by": {
143              "type": "object",
144              "properties": {
145                "username": {
146                  "type": "string",
147                  "description": "Username of the user who created the discount"
148                },
149                "user_id": {
150                  "type": "string",
151                  "description": "User ID of the user who created the discount"
152                }
153              },
154              "required": [
155                "username",
156                "user_id"
157              ],
158              "description": "Username of the user who created the discount"
159            },
160            "modified_by": {
161              "type": "object",
162              "properties": {
163                "username": {
164                  "type": "string",
165                  "description": "Username of the user who last modified the discount"
166                },
167                "user_id": {
168                  "type": "string",
169                  "description": "User ID of the user who last modified the discount"
170                }
171              },
172              "required": [
173                "username",
174                "user_id"
175              ],
176              "description": "The user who last modified the discount."
177            },
178            "created_on": {
179              "type": "string",
180              "description": "The date and time when the discount was created"
181            },
182            "modified_on": {
183              "type": "string",
184              "description": "The date and time when the discount was last modified"
185            },
186            "brand_ids": {
187              "type": "array",
188              "items": {
189                "type": "integer"
190              },
191              "description": "The discount will be applied to the products associated with the brand IDs listed."
192            },
193            "discount_meta": {
194              "type": "object",
195              "properties": {
196                "timer": {
197                  "type": "boolean",
198                  "description": "This field determines whether the countdown timer is visible or hidden.  A value of true means the timer is displayed, while false means it's hidden."
199                },
200                "hours": {
201                  "type": "integer",
202                  "description": "The time in hours before the discount ends when the countdown timer should start."
203                },
204                "minutes": {
205                  "type": "integer",
206                  "description": "The time in minutes before the discount ends when the countdown timer should start."
207                }
208              },
209              "required": [
210                "timer",
211                "hours",
212                "minutes"
213              ],
214              "description": "Holds information about the discount countdown timer displayed to the user"
215            },
216            "id": {
217              "type": "string",
218              "description": "The discount.id field contains a unique identifier of type ObjectId assigned to the discount."
219            }
220          },
221          "required": [
222            "job_type",
223            "name",
224            "is_active",
225            "discount_type",
226            "discount_level",
227            "company_id",
228            "app_ids",
229            "validity",
230            "id"
231          ],
232          "description": ""
233        }
234      },
235      "required": [
236        "discount"
237      ]
238    }
239  }
240}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "galvatron.611e9770-f259-11ee-b382-c921e5151b42"
5    ],
6    "name": "discount",
7    "type": "start",
8    "version": "1",
9    "created_timestamp": 1712217619047,
10    "id": "BX3XNehJyKTgxYcdLSF17dI+JnqGEl7yHH1+cc9T5gU=",
11    "category": "application"
12  },
13  "company_id": 7089,
14  "application_id": "65f95d4c5ce7282c80c71a3b",
15  "contains": [
16    "discount"
17  ],
18  "payload": {
19    "discount": {
20      "job_type": "app|brand|inventory",
21      "name": "DISCOUNT",
22      "file_path": "/company/7089/self/documents/product-import/free/original/0jFZnx9WU-discount-7089-sku-86lao7.xlsx",
23      "is_active": true,
24      "discount_type": "percentage",
25      "value": null,
26      "discount_meta": {
27        "timer": false,
28        "hours": 0,
29        "minutes": 0
30      },
31      "discount_level": "application",
32      "company_id": 7089,
33      "zone_ids": [],
34      "app_ids": [
35        "65f95d4c5ce7282c80c71a3b"
36      ],
37      "validity": {
38        "start": "2024-04-04T08:00:19.000Z",
39        "end": "2024-05-30T18:30:00.000Z"
40      },
41      "created_by": {
42        "username": "test_example_com_12345",
43        "user_id": "23532512"
44      },
45      "modified_by": {
46        "username": "test_example_com_12345",
47        "user_id": "23532512"
48      },
49      "created_on": "2024-04-04T07:45:29.749Z",
50      "modified_on": "2024-04-04T07:45:30.428Z",
51      "brand_ids": [
52        7914
53      ],
54      "id": "660e5a998fe23bcea999b86e"
55    }
56  }
57}

application/discount/update/v1

this event is triggered when discount 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
discount
object
Required
Properties
job_type
string
Required
Used to determines type of discount.
name
string
Required
The name of the discount
file_path
string
The file path of the uploaded file used to create the discount, particularly applicable for custom discounts.
is_active
boolean
Required
Whether the discount is currently active or not
discount_type
string
Required
The type of the discount
discount_level
string
Required
The level at which the discount will be applicable
company_id
integer
Required
The identifier of the company for which the discount was created
zone_ids
array of Undefined Type
The discount will be applied to the products associated with the delivery zones listed.
app_ids
array of string
Required
The discount will be applied to the products associated with the app IDs listed.
validity
object
Required
The duration during which the discount is applicable to the products.
Properties
start
string
Required
The commencement time of the discount period for the products.
end
string
Required
The conclusion time of the discount period for the products.
created_by
object
Username of the user who created the discount
Properties
username
string
Required
Username of the user who created the discount
user_id
string
Required
User ID of the user who created the discount
modified_by
object
The user who last modified the discount.
Properties
username
string
Required
Username of the user who last modified the discount
user_id
string
Required
User ID of the user who last modified the discount
created_on
string
The date and time when the discount was created
modified_on
string
The date and time when the discount was last modified
brand_ids
array of integer
The discount will be applied to the products associated with the brand IDs listed.
discount_meta
object
Holds information about the discount countdown timer displayed to the user
Properties
timer
boolean
Required
This field determines whether the countdown timer is visible or hidden. A value of true means the timer is displayed, while false means it's hidden.
hours
integer
Required
The time in hours before the discount ends when the countdown timer should start.
minutes
integer
Required
The time in minutes before the discount ends when the countdown timer should start.
id
string
Required
The discount.id field contains a unique identifier of type ObjectId assigned to the discount.
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      "properties": {
77        "discount": {
78          "type": "object",
79          "properties": {
80            "job_type": {
81              "type": "string",
82              "description": "Used to determines type of discount."
83            },
84            "name": {
85              "type": "string",
86              "description": "The name of the discount"
87            },
88            "file_path": {
89              "type": "string",
90              "description": "The file path of the uploaded file used to create the discount, particularly applicable for custom discounts."
91            },
92            "is_active": {
93              "type": "boolean",
94              "description": "Whether the discount is currently active or not"
95            },
96            "discount_type": {
97              "type": "string",
98              "description": "The type of the discount"
99            },
100            "discount_level": {
101              "type": "string",
102              "description": "The level at which the discount will be applicable"
103            },
104            "company_id": {
105              "type": "integer",
106              "description": "The identifier of the company for which the discount was created"
107            },
108            "zone_ids": {
109              "type": "array",
110              "items": [
111                {
112                  "type": "string"
113                }
114              ],
115              "description": "The discount will be applied to the products associated with the delivery zones listed."
116            },
117            "app_ids": {
118              "type": "array",
119              "items": {
120                "type": "string"
121              },
122              "description": "The discount will be applied to the products associated with the app IDs listed."
123            },
124            "validity": {
125              "type": "object",
126              "properties": {
127                "start": {
128                  "type": "string",
129                  "description": "The commencement time of the discount period for the products."
130                },
131                "end": {
132                  "type": "string",
133                  "description": "The conclusion time of the discount period for the products."
134                }
135              },
136              "required": [
137                "start",
138                "end"
139              ],
140              "description": "The duration during which the discount is applicable to the products."
141            },
142            "created_by": {
143              "type": "object",
144              "properties": {
145                "username": {
146                  "type": "string",
147                  "description": "Username of the user who created the discount"
148                },
149                "user_id": {
150                  "type": "string",
151                  "description": "User ID of the user who created the discount"
152                }
153              },
154              "required": [
155                "username",
156                "user_id"
157              ],
158              "description": "Username of the user who created the discount"
159            },
160            "modified_by": {
161              "type": "object",
162              "properties": {
163                "username": {
164                  "type": "string",
165                  "description": "Username of the user who last modified the discount"
166                },
167                "user_id": {
168                  "type": "string",
169                  "description": "User ID of the user who last modified the discount"
170                }
171              },
172              "required": [
173                "username",
174                "user_id"
175              ],
176              "description": "The user who last modified the discount."
177            },
178            "created_on": {
179              "type": "string",
180              "description": "The date and time when the discount was created"
181            },
182            "modified_on": {
183              "type": "string",
184              "description": "The date and time when the discount was last modified"
185            },
186            "brand_ids": {
187              "type": "array",
188              "items": {
189                "type": "integer"
190              },
191              "description": "The discount will be applied to the products associated with the brand IDs listed."
192            },
193            "discount_meta": {
194              "type": "object",
195              "properties": {
196                "timer": {
197                  "type": "boolean",
198                  "description": "This field determines whether the countdown timer is visible or hidden.  A value of true means the timer is displayed, while false means it's hidden."
199                },
200                "hours": {
201                  "type": "integer",
202                  "description": "The time in hours before the discount ends when the countdown timer should start."
203                },
204                "minutes": {
205                  "type": "integer",
206                  "description": "The time in minutes before the discount ends when the countdown timer should start."
207                }
208              },
209              "required": [
210                "timer",
211                "hours",
212                "minutes"
213              ],
214              "description": "Holds information about the discount countdown timer displayed to the user"
215            },
216            "id": {
217              "type": "string",
218              "description": "The discount.id field contains a unique identifier of type ObjectId assigned to the discount."
219            }
220          },
221          "required": [
222            "job_type",
223            "name",
224            "is_active",
225            "discount_type",
226            "discount_level",
227            "company_id",
228            "app_ids",
229            "validity",
230            "id"
231          ],
232          "description": ""
233        }
234      },
235      "required": [
236        "discount"
237      ]
238    }
239  }
240}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "galvatron.383fda70-efb2-11ee-9f71-6b13d47b08a7"
5    ],
6    "name": "discount",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711925922199,
10    "id": "iODieB89d9h9JcqA7yaxX4tyddAN5izmQzRDKMzo6w8=",
11    "category": "application"
12  },
13  "company_id": 25,
14  "application_id": "618a224ce93512680cfd93d0",
15  "contains": [
16    "discount"
17  ],
18  "payload": {
19    "discount": {
20      "job_type": "app|brand|inventory",
21      "name": "MYNTRA EOSS DISCOUNT",
22      "file_path": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/25/self/documents/product-import/free/original/Jid9SRa6z-RiyTkKqRX-discout_sku_sample-Updated-27.3-licensee-revised.xlsx",
23      "is_active": true,
24      "discount_type": "percentage",
25      "value": null,
26      "discount_level": "application",
27      "company_id": 25,
28      "zone_ids": [],
29      "app_ids": [
30        "618a224ce93512680cfd93d0"
31      ],
32      "validity": {
33        "start": "2023-07-14T19:15:09.916Z",
34        "end": "2024-04-02T18:15:00.000Z"
35      },
36      "created_by": {
37        "username": "test_example_com_12345",
38        "user_id": "23108124"
39      },
40      "modified_by": {
41        "username": "test_example_com_12345",
42        "user_id": "23108124"
43      },
44      "created_on": "2023-07-14T19:12:25.370Z",
45      "modified_on": "2024-03-31T22:58:42.194Z",
46      "brand_ids": [
47        44
48      ],
49      "discount_meta": {
50        "timer": false,
51        "hours": 0,
52        "minutes": 0
53      },
54      "id": "64b19e1989d131ab16c58522"
55    }
56  }
57}

Domain

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

Events
application/domain/create/v1
# this event is triggered when domain is created
application/domain/delete/v1
# this event is triggered when domain is deleted

application/domain/create/v1

this event is triggered when domain 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
domain
object
Required
An object representing a domain, which typically includes various attributes and properties related to a specific domain.
Properties
id
string
Required
ID of the created domain
name
string
Required
URL of the domain
verified
boolean
Required
Shows if the domain is verified or not
is_primary
boolean
Required
Shows if the domain is primary or not
is_shortLink
boolean
Required
This Boolean field indicates whether the domain is a short link or not.
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        "domain"
78      ],
79      "properties": {
80        "domain": {
81          "type": "object",
82          "description": "An object representing a domain, which typically includes various attributes and properties related to a specific domain.",
83          "required": [
84            "id",
85            "name",
86            "verified",
87            "is_primary",
88            "is_shortLink"
89          ],
90          "properties": {
91            "id": {
92              "type": "string",
93              "description": "ID of the created domain"
94            },
95            "name": {
96              "type": "string",
97              "description": "URL of the domain"
98            },
99            "verified": {
100              "type": "boolean",
101              "description": "Shows if the domain is verified or not"
102            },
103            "is_primary": {
104              "type": "boolean",
105              "description": "Shows if the domain is primary or not"
106            },
107            "is_shortLink": {
108              "type": "boolean",
109              "description": "This Boolean field indicates whether the domain is a short link or not."
110            }
111          }
112        }
113      }
114    }
115  }
116}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "slingshot.713856c7-5a08-4476-ae0b-9407b50b8c54"
5    ],
6    "name": "domain",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712043569378,
10    "id": "xmejd99gGMIxiIc9RWvFxUZ/t9Q8JJeFefVr13yMymU=",
11    "category": "application"
12  },
13  "company_id": 6654,
14  "application_id": "65a6edddbc250d9e3be73e19",
15  "contains": [
16    "domain"
17  ],
18  "payload": {
19    "domain": {
20      "id": "660bb6310b32949adcc54b0f",
21      "name": "junziuae.fynd.io",
22      "verified": true,
23      "is_primary": false,
24      "is_shortLink": false
25    }
26  }
27}

application/domain/delete/v1

this event is triggered when domain 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
domain
object
Required
An object representing a domain, which typically includes various attributes and properties related to a specific domain.
Properties
id
string
Required
ID of the created domain
name
string
Required
URL of the domain
verified
boolean
Required
Shows if the domain is verified or not
is_primary
boolean
Required
Shows if the domain is primary or not
is_shortLink
boolean
Required
This Boolean field indicates whether the domain is a short link or not.
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        "domain"
78      ],
79      "properties": {
80        "domain": {
81          "description": "An object representing a domain, which typically includes various attributes and properties related to a specific domain.",
82          "type": "object",
83          "required": [
84            "id",
85            "name",
86            "verified",
87            "is_primary",
88            "is_shortLink"
89          ],
90          "properties": {
91            "id": {
92              "type": "string",
93              "description": "ID of the created domain"
94            },
95            "name": {
96              "type": "string",
97              "description": "URL of the domain"
98            },
99            "verified": {
100              "type": "boolean",
101              "description": "Shows if the domain is verified or not"
102            },
103            "is_primary": {
104              "type": "boolean",
105              "description": "Shows if the domain is primary or not"
106            },
107            "is_shortLink": {
108              "type": "boolean",
109              "description": "This Boolean field indicates whether the domain is a short link or not."
110            }
111          }
112        }
113      }
114    }
115  }
116}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "slingshot.713856c7-5a08-4476-ae0b-9407b50b8c54"
5    ],
6    "name": "domain",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712043569378,
10    "id": "xmejd99gGMIxiIc9RWvFxUZ/t9Q8JJeFefVr13yMymU=",
11    "category": "application"
12  },
13  "company_id": 6654,
14  "application_id": "65a6edddbc250d9e3be73e19",
15  "contains": [
16    "domain"
17  ],
18  "payload": {
19    "domain": {
20      "id": "660bb6310b32949adcc54b0f",
21      "name": "junziuae.fynd.io",
22      "verified": true,
23      "is_primary": false,
24      "is_shortLink": false
25    }
26  }
27}

Faq

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

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

application/faq/create/v1

this event is triggered when faq 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
faq
object
Required
Properties
__v
integer
Required
_id
string
Required
slug
string
Required
Last part of a Human readable URL where the FAQ details can be found
answer
string
Required
Details related to the answer
question
string
Required
Details related to the question
application
string
Required
sales channel ID to which this FAQ is related
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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.92b267a9-682a-4f06-b3ac-bd7e5fde92e8"
5    ],
6    "name": "faq",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712050560823,
10    "id": "6kEedI7OCSRV0i+kuwm26eV9TBGXipeBgqI1Ka/6F1A=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "application": "65d2fb0cbe02fc23cf17d45f",
21      "slug": "fa",
22      "question": "How did NutriWellments get its name?",
23      "answer": "***The name NutriWellments is derived from \"nutrition,\" \"wellbeing,\" and \"supplements,\" reflecting our commitment to comprehensive health support.***",
24      "tags": [],
25      "_id": "660bd1805c786cf7642d8f81",
26      "__v": 0
27    }
28  }
29}

application/faq/delete/v1

this event is triggered when faq 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
faq
object
Required
Properties
__v
integer
Required
_id
string
Required
slug
string
Required
Last part of a Human readable URL where the FAQ details can be found
answer
string
Required
Details related to the answer
question
string
Required
Details related to the question
application
string
Required
sales channel ID to which this FAQ is related
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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.32f769e4-b310-42d1-b4c7-79d32f9faf17"
5    ],
6    "name": "faq",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712050213101,
10    "id": "7if3+DeqSJ/8qWnv/RltI4UYEJlAtzMYPVAamPALkDA=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "_id": "65f422c8b13e657d086d7f53",
21      "application": "65d2fb0cbe02fc23cf17d45f",
22      "slug": "faqs",
23      "question": "Have the supplements been tested?",
24      "answer": "Yes, our supplements undergo rigorous testing to ensure quality, safety, and efficacy. We prioritize transparency.",
25      "tags": [],
26      "__v": 0
27    }
28  }
29}

application/faq/update/v1

this event is triggered when faq 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
faq
object
Required
Properties
__v
integer
Required
_id
string
Required
slug
string
Required
Last part of a Human readable URL where the FAQ details can be found
answer
string
Required
Details related to the answer
question
string
Required
Details related to the question
application
string
Required
sales channel ID to which this FAQ is related
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        "faq"
78      ],
79      "properties": {
80        "faq": {
81          "type": "object",
82          "required": [
83            "_id",
84            "question",
85            "answer",
86            "slug",
87            "application",
88            "__v"
89          ],
90          "properties": {
91            "__v": {
92              "type": "integer"
93            },
94            "_id": {
95              "type": "string"
96            },
97            "slug": {
98              "type": "string",
99              "description": "Last part of a Human readable URL where the FAQ details can be found"
100            },
101            "answer": {
102              "type": "string",
103              "description": "Details related to the answer"
104            },
105            "question": {
106              "type": "string",
107              "description": "Details related to the question"
108            },
109            "application": {
110              "type": "string",
111              "description": "sales channel ID to which this FAQ is related"
112            }
113          }
114        }
115      }
116    }
117  }
118}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.e28ebd58-a1b7-4319-8187-d743c214e4e6"
5    ],
6    "name": "faq",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712050804033,
10    "id": "CKNFtYVNdFzHguonUnbsCAmpANX8zzyzSNNMK7Vw/Gw=",
11    "category": "application"
12  },
13  "company_id": 6902,
14  "application_id": "65d2fb0cbe02fc23cf17d45f",
15  "contains": [
16    "faq"
17  ],
18  "payload": {
19    "faq": {
20      "_id": "660bd1805c786cf7642d8f81",
21      "application": "65d2fb0cbe02fc23cf17d45f",
22      "slug": "fa",
23      "question": "How did NutriWellments get its name?",
24      "answer": "The name NutriWellments is derived from \"nutrition,\" \"wellbeing,\" and \"supplements,\" reflecting our commitment to comprehensive health support.",
25      "tags": [],
26      "__v": 0
27    }
28  }
29}

Filter configuration

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

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

application/filter/create/v1

this event is triggered when filter 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
filter
object
Required
Properties
id
string
Required
UUID of the filter config.
key
string
Required
Slug of the product attribute.
logo
string
Logo to show for the filter in the configuration.
name
string
Required
Display Name of the filter.
attribute_name
string
Name of the product attribute.
type
string
Required
Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.
Enum
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the filters.
is_active
boolean
Required
Active status of the filter. Turn off the filter from here.
is_default
boolean
Required
Default filter values from the system.
allow_single
boolean
Required
You can disable this to hide filters for a single listed
value_config
object
Required
Contains the value mapping for the custom filter.
Properties
map
object
Maps the filter value to a display format based on buckets.
sort
string
Sort the filter values based on the selected criteria.
condition
string
Criteria to apply when multivalues are selected in a filter ['AND', 'OR'].
value
string
Value configuration for the filter.
map_values
array of object
Array of mapped values for the filter.
bucket_points
array of object
In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].
Array of Properties
start
integer
Required
Start point of the bucket.
end
integer
Required
End point of the bucket.
display
string
Display text for the bucket.
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        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "attribute_name": {
113              "type": "string",
114              "description": "Name of the product attribute."
115            },
116            "type": {
117              "type": "string",
118              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
119              "enum": [
120                "range",
121                "intervals",
122                "multivalued",
123                "singlevalued"
124              ]
125            },
126            "app_id": {
127              "type": "string",
128              "description": "Unique ID of the application."
129            },
130            "priority": {
131              "type": "integer",
132              "description": "Position of the filters."
133            },
134            "is_active": {
135              "type": "boolean",
136              "description": "Active status of the filter. Turn off the filter from here."
137            },
138            "is_default": {
139              "type": "boolean",
140              "description": "Default filter values from the system."
141            },
142            "allow_single": {
143              "type": "boolean",
144              "description": "You can disable this to hide filters for a single listed "
145            },
146            "value_config": {
147              "type": "object",
148              "description": "Contains the value mapping for the custom filter.",
149              "required": [],
150              "properties": {
151                "map": {
152                  "type": "object",
153                  "additionalProperties": true,
154                  "description": "Maps the filter value to a display format based on buckets."
155                },
156                "sort": {
157                  "type": "string",
158                  "description": "Sort the filter values based on the selected criteria."
159                },
160                "condition": {
161                  "type": "string",
162                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
163                },
164                "value": {
165                  "type": "string",
166                  "description": "Value configuration for the filter."
167                },
168                "map_values": {
169                  "type": "array",
170                  "description": "Array of mapped values for the filter.",
171                  "items": {
172                    "type": "object"
173                  }
174                },
175                "bucket_points": {
176                  "type": "array",
177                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
178                  "items": {
179                    "type": "object",
180                    "required": [
181                      "start",
182                      "end"
183                    ],
184                    "properties": {
185                      "start": {
186                        "type": "integer",
187                        "description": "Start point of the bucket."
188                      },
189                      "end": {
190                        "type": "integer",
191                        "description": "End point of the bucket."
192                      },
193                      "display": {
194                        "type": "string",
195                        "description": "Display text for the bucket."
196                      }
197                    }
198                  }
199                }
200              }
201            }
202          }
203        }
204      }
205    }
206  }
207}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3db902e4-f2bc-11ee-b2ca-4a5bb17c04ae"
5    ],
6    "name": "filter",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712260079837,
10    "id": "KwMA/8ONiZMADtk729zTLix3Y/godP6B97+QZg1Ce24=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "is_default": false,
25      "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/test/general/free/original/samplePNG.png",
26      "key": "lera765468244320241947615",
27      "allow_single": true,
28      "is_active": true,
29      "value_config": {
30        "value": "",
31        "sort": "count",
32        "map": {},
33        "condition": "OR",
34        "bucket_points": []
35      },
36      "app_id": "660edfcaaaaa57fb0b439b31",
37      "priority": 1,
38      "name": "Lera765468244320241947615",
39      "type": "multivalued",
40      "id": "660f03dea62b335af099a5af",
41      "default_key": "lera765468244320241947615"
42    }
43  }
44}

application/filter/delete/v1

this event is triggered when filter 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
filter
object
Required
Properties
id
string
Required
UUID of the filter config.
key
string
Required
Slug of the product attribute.
logo
string
Logo to show for the filter in the configuration.
name
string
Required
Display Name of the filter.
type
string
Required
Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.
Enum
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the filters.
is_active
boolean
Required
Active status of the filter. Turn off the filter from here.
is_default
boolean
Required
Default filter values from the system.
allow_single
boolean
Required
You can disable this to hide filters for a single listed
value_config
object
Required
Contains the value mapping for the custom filter.
Properties
map
object
Maps the filter value to a display format based on buckets.
sort
string
Sort the filter values based on the selected criteria.
value
string
Value configuration for the filter.
condition
string
Criteria to apply when multivalues are selected in a filter ['AND', 'OR'].
map_values
array of object
Array of mapped values for the filter.
bucket_points
array of object
In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].
Array of Properties
end
number
End point of the bucket.
start
number
Start point of the bucket.
display
string
Display text for the bucket.
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        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "type": {
113              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
114              "enum": [
115                "range",
116                "intervals",
117                "multivalued",
118                "singlevalued"
119              ],
120              "type": "string"
121            },
122            "app_id": {
123              "type": "string",
124              "description": "Unique ID of the application."
125            },
126            "priority": {
127              "type": "integer",
128              "description": "Position of the filters."
129            },
130            "is_active": {
131              "type": "boolean",
132              "description": "Active status of the filter. Turn off the filter from here."
133            },
134            "is_default": {
135              "type": "boolean",
136              "description": "Default filter values from the system."
137            },
138            "allow_single": {
139              "type": "boolean",
140              "description": "You can disable this to hide filters for a single listed "
141            },
142            "value_config": {
143              "type": "object",
144              "required": [],
145              "description": "Contains the value mapping for the custom filter.",
146              "properties": {
147                "map": {
148                  "type": "object",
149                  "additionalProperties": true,
150                  "description": "Maps the filter value to a display format based on buckets."
151                },
152                "sort": {
153                  "type": "string",
154                  "description": "Sort the filter values based on the selected criteria."
155                },
156                "value": {
157                  "type": "string",
158                  "description": "Value configuration for the filter."
159                },
160                "condition": {
161                  "type": "string",
162                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
163                },
164                "map_values": {
165                  "type": "array",
166                  "description": "Array of mapped values for the filter.",
167                  "items": {
168                    "type": "object"
169                  }
170                },
171                "bucket_points": {
172                  "type": "array",
173                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
174                  "items": {
175                    "type": "object",
176                    "required": [],
177                    "properties": {
178                      "end": {
179                        "type": "number",
180                        "description": "End point of the bucket."
181                      },
182                      "start": {
183                        "type": "number",
184                        "description": "Start point of the bucket."
185                      },
186                      "display": {
187                        "type": "string",
188                        "description": "Display text for the bucket."
189                      }
190                    }
191                  }
192                }
193              }
194            }
195          }
196        }
197      }
198    }
199  }
200}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3ee17fd4-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "filter",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260081780,
10    "id": "4vQFTEsbV60x7tXDHveQWP8IiSWjXXkn/oXtfi2Nz88=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "is_default": false,
25      "logo": "/addsale/test/general/free/original/samplePNG.png",
26      "key": "lera765468244320241947615",
27      "allow_single": true,
28      "is_active": true,
29      "value_config": {
30        "condition": "OR",
31        "bucket_points": [],
32        "map": {},
33        "value": "",
34        "sort": "count"
35      },
36      "app_id": "660edfcaaaaa57fb0b439b31",
37      "priority": 2,
38      "name": "Tiffany400533844320241948224",
39      "type": "multivalued",
40      "id": "660f03ef232e18b066ffcfce"
41    }
42  }
43}

application/filter/update/v1

this event is triggered when filter 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
filter
object
Required
Properties
id
string
Required
UUID of the filter config.
key
string
Required
Slug of the product attribute.
logo
string
Logo to show for the filter in the configuration.
name
string
Required
Display Name of the filter.
type
string
Required
Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.
Enum
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the filters.
is_active
boolean
Required
Active status of the filter. Turn off the filter from here.
is_default
boolean
Required
Default filter values from the system.
allow_single
boolean
Required
You can disable this to hide filters for a single listed
filter_types
array of string
List of supported filter types.
Enum
attr_name
string
Name of the attribute to which the filter applies.
priceRanges
array of object
Range values for price filters.
Array of Properties
text
string
Display text for the price range.
value
string
Internal value representation for the price range.
addMoreCount
integer
Additional count value for the filter.
lastRangeBucket
object
Details about the last bucket range for the filter.
Properties
value
number
Value of the last range bucket.
display
string
Display text for the last range bucket.
priceRangesValue
string
Value configuration for price ranges.
value_config
object
Required
Contains the value mapping for the custom filter.
Properties
map
object
Maps the filter value to a display format based on buckets.
sort
string
Sort the filter values based on the selected criteria.
value
string
Value configuration for the filter.
condition
string
Criteria to apply when multivalues are selected in a filter ['AND', 'OR'].
map_values
array of object
Array of mapped values for the filter.
bucket_points
array of object
In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].
Array of Properties
end
number
End point of the bucket.
start
number
Start point of the bucket.
display
string
Display text for the bucket.
priority
array of string
Priority of the filter values.
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        "filter"
78      ],
79      "properties": {
80        "filter": {
81          "type": "object",
82          "description": "",
83          "required": [
84            "app_id",
85            "id",
86            "key",
87            "is_active",
88            "priority",
89            "is_default",
90            "allow_single",
91            "type",
92            "name",
93            "value_config"
94          ],
95          "properties": {
96            "id": {
97              "type": "string",
98              "description": "UUID of the filter config."
99            },
100            "key": {
101              "type": "string",
102              "description": "Slug of the product attribute."
103            },
104            "logo": {
105              "type": "string",
106              "description": "Logo to show for the filter in the configuration."
107            },
108            "name": {
109              "type": "string",
110              "description": "Display Name of the filter."
111            },
112            "type": {
113              "description": "Type of the filter such as Range Slider, Custom Text, MultiValued, Custom Bucket.",
114              "enum": [
115                "range",
116                "intervals",
117                "multivalued",
118                "singlevalued"
119              ],
120              "type": "string"
121            },
122            "app_id": {
123              "type": "string",
124              "description": "Unique ID of the application."
125            },
126            "priority": {
127              "type": "integer",
128              "description": "Position of the filters."
129            },
130            "is_active": {
131              "type": "boolean",
132              "description": "Active status of the filter. Turn off the filter from here."
133            },
134            "is_default": {
135              "type": "boolean",
136              "description": "Default filter values from the system."
137            },
138            "allow_single": {
139              "type": "boolean",
140              "description": "You can disable this to hide filters for a single listed"
141            },
142            "filter_types": {
143              "type": "array",
144              "items": {
145                "type": "string",
146                "enum": [
147                  "intervals",
148                  "multivalued",
149                  "range",
150                  "singlevalued"
151                ]
152              },
153              "description": "List of supported filter types."
154            },
155            "attr_name": {
156              "type": "string",
157              "description": "Name of the attribute to which the filter applies."
158            },
159            "priceRanges": {
160              "type": "array",
161              "description": "Range values for price filters.",
162              "items": {
163                "type": "object",
164                "properties": {
165                  "text": {
166                    "type": "string",
167                    "description": "Display text for the price range."
168                  },
169                  "value": {
170                    "type": "string",
171                    "description": "Internal value representation for the price range."
172                  }
173                }
174              }
175            },
176            "addMoreCount": {
177              "type": "integer",
178              "description": "Additional count value for the filter."
179            },
180            "lastRangeBucket": {
181              "type": "object",
182              "description": "Details about the last bucket range for the filter.",
183              "properties": {
184                "value": {
185                  "type": "number",
186                  "description": "Value of the last range bucket."
187                },
188                "display": {
189                  "type": "string",
190                  "description": "Display text for the last range bucket."
191                }
192              }
193            },
194            "priceRangesValue": {
195              "type": "string",
196              "description": "Value configuration for price ranges."
197            },
198            "value_config": {
199              "type": "object",
200              "description": "Contains the value mapping for the custom filter.",
201              "required": [],
202              "properties": {
203                "map": {
204                  "type": "object",
205                  "additionalProperties": true,
206                  "description": "Maps the filter value to a display format based on buckets."
207                },
208                "sort": {
209                  "type": "string",
210                  "description": "Sort the filter values based on the selected criteria."
211                },
212                "value": {
213                  "type": "string",
214                  "description": "Value configuration for the filter."
215                },
216                "condition": {
217                  "type": "string",
218                  "description": "Criteria to apply when multivalues are selected in a filter ['AND', 'OR']."
219                },
220                "map_values": {
221                  "type": "array",
222                  "description": "Array of mapped values for the filter.",
223                  "items": {
224                    "type": "object"
225                  }
226                },
227                "bucket_points": {
228                  "type": "array",
229                  "description": "In case of range filter, the bucket point will represent the values of each bucket [{start, end}, {start, end}].",
230                  "items": {
231                    "type": "object",
232                    "required": [],
233                    "properties": {
234                      "end": {
235                        "type": "number",
236                        "description": "End point of the bucket."
237                      },
238                      "start": {
239                        "type": "number",
240                        "description": "Start point of the bucket."
241                      },
242                      "display": {
243                        "type": "string",
244                        "description": "Display text for the bucket."
245                      }
246                    }
247                  }
248                },
249                "priority": {
250                  "type": "array",
251                  "description": "Priority of the filter values.",
252                  "items": {
253                    "type": "string"
254                  }
255                }
256              }
257            }
258          }
259        }
260      }
261    }
262  }
263}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3df9b7d0-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "filter",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260080261,
10    "id": "QIKNnlUyZ7m8mmyOG7Bjs0gX7Zh5DyfsFMDEmtrq36I=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "filter"
21  ],
22  "payload": {
23    "filter": {
24      "value_config": {
25        "condition": "OR",
26        "sort": "count",
27        "value": "",
28        "map": {},
29        "bucket_points": []
30      },
31      "name": "Lera765468244320241947615",
32      "logo": "/addsale/test/general/free/original/samplePNG.png",
33      "id": "660f03ef232e18b066ffcfce",
34      "allow_single": true,
35      "is_active": false,
36      "priority": 1,
37      "is_default": false,
38      "app_id": "660edfcaaaaa57fb0b439b31",
39      "key": "lera765468244320241947615",
40      "type": "multivalued",
41      "default_key": "lera765468244320241947615"
42    }
43  }
44}

Location price

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

Events
application/location-price/create/v1
# this event is triggered when location price is create
application/location-price/update/v1
# this event is triggered when location price is updated
application/location-price/delete/v1
# this event is triggered when location is deleted

application/location-price/create/v1

this event is triggered when location price is create

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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
size
string
Required
Product size (e.g., S, M, L, XL).
item_id
integer
Required
Unique identifier for the item.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
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.
selling
number
Selling price of the product.
updated_at
string|null
| date-time
Date and time when the pricing information was last updated.
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.
is_active
boolean
Required
Indicates if the product is currently active (available for sale).
stage
string
Current stage of the product lifecycle (e.g., verified).
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
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.
discount_applied
boolean
flag to know whether discount is applied or not.
discount_job_id
string
Identifier for the discount job, if any discount is live.
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        "prices"
78      ],
79      "properties": {
80        "prices": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "price",
89              "store",
90              "company",
91              "item_id",
92              "date_meta",
93              "fynd_item_code",
94              "seller_identifier",
95              "is_active"
96            ],
97            "properties": {
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "fynd_item_code": {
103                "type": "string",
104                "description": "Fynd's unique internal code for the product."
105              },
106              "seller_identifier": {
107                "type": "string",
108                "description": "Unique identifier used by the seller for the product."
109              },
110              "size": {
111                "type": "string",
112                "description": "Product size (e.g., S, M, L, XL)."
113              },
114              "item_id": {
115                "type": "integer",
116                "description": "Unique identifier for the item."
117              },
118              "company": {
119                "type": "object",
120                "description": "Information about the company producing or selling the product.",
121                "properties": {
122                  "id": {
123                    "type": "integer",
124                    "description": "Unique identifier for the company."
125                  }
126                },
127                "required": [
128                  "id"
129                ]
130              },
131              "brand": {
132                "type": "object",
133                "description": "Details about the product's brand.",
134                "properties": {
135                  "id": {
136                    "type": "integer",
137                    "description": "Unique identifier for the brand."
138                  }
139                },
140                "required": [
141                  "id"
142                ]
143              },
144              "store": {
145                "type": "object",
146                "description": "Information about the store selling the product.",
147                "properties": {
148                  "id": {
149                    "type": "integer",
150                    "description": "Unique identifier for the store."
151                  }
152                },
153                "required": [
154                  "id"
155                ]
156              },
157              "price": {
158                "type": "object",
159                "description": "Pricing details of the product, including various price types.",
160                "properties": {
161                  "transfer": {
162                    "type": "number",
163                    "description": "Transfer price of the product."
164                  },
165                  "effective": {
166                    "type": "number",
167                    "description": "Final price after applying discounts."
168                  },
169                  "currency": {
170                    "type": "string",
171                    "description": "Currency used for the product's pricing (e.g., USD, EUR)."
172                  },
173                  "marked": {
174                    "type": "number",
175                    "description": "Marked price or original listed price of the product."
176                  },
177                  "selling": {
178                    "type": "number",
179                    "description": "Selling price of the product."
180                  },
181                  "updated_at": {
182                    "type": [
183                      "string",
184                      "null"
185                    ],
186                    "format": "date-time",
187                    "description": "Date and time when the pricing information was last updated."
188                  }
189                },
190                "required": [
191                  "transfer",
192                  "effective",
193                  "currency",
194                  "marked"
195                ]
196              },
197              "date_meta": {
198                "type": "object",
199                "description": "Timestamps for important events in the product's lifecycle.",
200                "properties": {
201                  "created_on": {
202                    "type": "string",
203                    "format": "date-time",
204                    "description": "Date and time when the product was first created."
205                  },
206                  "modified_on": {
207                    "type": "string",
208                    "format": "date-time",
209                    "description": "Last modification timestamp of the product inventory details."
210                  },
211                  "added_on_store": {
212                    "type": "string",
213                    "format": "date-time",
214                    "description": "Date and time when the product was added to the store."
215                  },
216                  "inventory_updated_on": {
217                    "type": "string",
218                    "format": "date-time",
219                    "description": "Last inventory update timestamp."
220                  }
221                }
222              },
223              "is_active": {
224                "type": "boolean",
225                "description": "Indicates if the product is currently active (available for sale)."
226              },
227              "stage": {
228                "type": "string",
229                "description": "Current stage of the product lifecycle (e.g., verified)."
230              },
231              "tags": {
232                "type": "array",
233                "description": "Tags or labels assigned to the product for categorization or search purposes.",
234                "items": {
235                  "type": "string"
236                }
237              },
238              "discount_meta": {
239                "type": "object",
240                "description": "Details of any discounts, including start/end times and countdown timers.",
241                "properties": {
242                  "start": {
243                    "type": "string",
244                    "format": "date-time",
245                    "description": "Start date and time of the discount period."
246                  },
247                  "end": {
248                    "type": "string",
249                    "format": "date-time",
250                    "description": "End date and time of the discount period."
251                  },
252                  "timer": {
253                    "type": "boolean",
254                    "description": "Indicates if a countdown timer is active for the discount."
255                  }
256                }
257              },
258              "discount_applied": {
259                "type": "boolean",
260                "description": "flag to know whether discount is applied or not."
261              },
262              "discount_job_id": {
263                "type": "string",
264                "description": "Identifier for the discount job, if any discount is live."
265              }
266            }
267          }
268        }
269      }
270    }
271  }
272}
Payload Example
1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "prices"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-price",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "create",
19    "version": "1"
20  },
21  "payload": {
22    "prices": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
30        "date_meta": {
31          "added_on_store": "test",
32          "created_on": "test",
33          "inventory_updated_on": "2024-04-03 11:25:38.723172",
34          "modified_on": "2024-04-03 11:25:38.723172"
35        },
36        "fynd_item_code": "MCOP00015_SKYBLUE",
37        "item_id": 8609293,
38        "price": {
39          "currency": "INR",
40          "effective": 6500,
41          "marked": 7999,
42          "selling": 7000,
43          "transfer": 0
44        },
45        "seller_identifier": "MCOP00015_SKYBLUE_40",
46        "size": "40/1.02M",
47        "store": {
48          "id": 15856
49        },
50        "uid": "15856_MCOP00015_SKYBLUE_40",
51        "discount_meta": {
52          "start": "2024-09-06T13:52:27Z",
53          "end": "2024-09-06T14:20:27.304000Z",
54          "timer": false
55        },
56        "discount_applied": true,
57        "is_active": true,
58        "stage": "verified",
59        "tags": []
60      }
61    ]
62  }
63}

application/location-price/update/v1

this event is triggered when location price 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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
size
string
Required
Product size (e.g., S, M, L, XL).
item_id
integer
Required
Unique identifier for the item.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
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.
selling
number
Selling price of the product.
updated_at
string|null
| date-time
Date and time when the pricing information was last updated.
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.
is_active
boolean
Required
Indicates if the product is currently active (available for sale).
stage
string
Current stage of the product lifecycle (e.g., verified).
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
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.
discount_applied
boolean
flag to know whether discount is applied or not.
discount_job_id
string
Identifier for the discount job, if any discount is live.
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        "prices"
78      ],
79      "properties": {
80        "prices": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "price",
89              "store",
90              "company",
91              "item_id",
92              "date_meta",
93              "fynd_item_code",
94              "seller_identifier",
95              "is_active"
96            ],
97            "properties": {
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "fynd_item_code": {
103                "type": "string",
104                "description": "Fynd's unique internal code for the product."
105              },
106              "seller_identifier": {
107                "type": "string",
108                "description": "Unique identifier used by the seller for the product."
109              },
110              "size": {
111                "type": "string",
112                "description": "Product size (e.g., S, M, L, XL)."
113              },
114              "item_id": {
115                "type": "integer",
116                "description": "Unique identifier for the item."
117              },
118              "company": {
119                "type": "object",
120                "description": "Information about the company producing or selling the product.",
121                "properties": {
122                  "id": {
123                    "type": "integer",
124                    "description": "Unique identifier for the company."
125                  }
126                },
127                "required": [
128                  "id"
129                ]
130              },
131              "brand": {
132                "type": "object",
133                "description": "Details about the product's brand.",
134                "properties": {
135                  "id": {
136                    "type": "integer",
137                    "description": "Unique identifier for the brand."
138                  }
139                },
140                "required": [
141                  "id"
142                ]
143              },
144              "store": {
145                "type": "object",
146                "description": "Information about the store selling the product.",
147                "properties": {
148                  "id": {
149                    "type": "integer",
150                    "description": "Unique identifier for the store."
151                  }
152                },
153                "required": [
154                  "id"
155                ]
156              },
157              "price": {
158                "type": "object",
159                "description": "Pricing details of the product, including various price types.",
160                "properties": {
161                  "transfer": {
162                    "type": "number",
163                    "description": "Transfer price of the product."
164                  },
165                  "effective": {
166                    "type": "number",
167                    "description": "Final price after applying discounts."
168                  },
169                  "currency": {
170                    "type": "string",
171                    "description": "Currency used for the product's pricing (e.g., USD, EUR)."
172                  },
173                  "marked": {
174                    "type": "number",
175                    "description": "Marked price or original listed price of the product."
176                  },
177                  "selling": {
178                    "type": "number",
179                    "description": "Selling price of the product."
180                  },
181                  "updated_at": {
182                    "type": [
183                      "string",
184                      "null"
185                    ],
186                    "format": "date-time",
187                    "description": "Date and time when the pricing information was last updated."
188                  }
189                },
190                "required": [
191                  "transfer",
192                  "effective",
193                  "currency",
194                  "marked"
195                ]
196              },
197              "date_meta": {
198                "type": "object",
199                "description": "Timestamps for important events in the product's lifecycle.",
200                "properties": {
201                  "created_on": {
202                    "type": "string",
203                    "format": "date-time",
204                    "description": "Date and time when the product was first created."
205                  },
206                  "modified_on": {
207                    "type": "string",
208                    "format": "date-time",
209                    "description": "Last modification timestamp of the product inventory details."
210                  },
211                  "added_on_store": {
212                    "type": "string",
213                    "format": "date-time",
214                    "description": "Date and time when the product was added to the store."
215                  },
216                  "inventory_updated_on": {
217                    "type": "string",
218                    "format": "date-time",
219                    "description": "Last inventory update timestamp."
220                  }
221                }
222              },
223              "is_active": {
224                "type": "boolean",
225                "description": "Indicates if the product is currently active (available for sale)."
226              },
227              "stage": {
228                "type": "string",
229                "description": "Current stage of the product lifecycle (e.g., verified)."
230              },
231              "tags": {
232                "type": "array",
233                "description": "Tags or labels assigned to the product for categorization or search purposes.",
234                "items": {
235                  "type": "string"
236                }
237              },
238              "discount_meta": {
239                "type": "object",
240                "description": "Details of any discounts, including start/end times and countdown timers.",
241                "properties": {
242                  "start": {
243                    "type": "string",
244                    "format": "date-time",
245                    "description": "Start date and time of the discount period."
246                  },
247                  "end": {
248                    "type": "string",
249                    "format": "date-time",
250                    "description": "End date and time of the discount period."
251                  },
252                  "timer": {
253                    "type": "boolean",
254                    "description": "Indicates if a countdown timer is active for the discount."
255                  }
256                }
257              },
258              "discount_applied": {
259                "type": "boolean",
260                "description": "flag to know whether discount is applied or not."
261              },
262              "discount_job_id": {
263                "type": "string",
264                "description": "Identifier for the discount job, if any discount is live."
265              }
266            }
267          }
268        }
269      }
270    }
271  }
272}
Payload Example
1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "prices"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-price",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "update",
19    "version": "1"
20  },
21  "payload": {
22    "prices": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
30        "date_meta": {
31          "added_on_store": "test",
32          "created_on": "test",
33          "inventory_updated_on": "2024-04-03 11:25:38.723172",
34          "modified_on": "2024-04-03 11:25:38.723172"
35        },
36        "fynd_item_code": "MCOP00015_SKYBLUE",
37        "item_id": 8609293,
38        "price": {
39          "currency": "INR",
40          "effective": 6500,
41          "marked": 7999,
42          "selling": 7000,
43          "transfer": 0
44        },
45        "seller_identifier": "MCOP00015_SKYBLUE_40",
46        "size": "40/1.02M",
47        "store": {
48          "id": 15856
49        },
50        "uid": "15856_MCOP00015_SKYBLUE_40",
51        "discount_meta": {
52          "start": "2024-09-06T13:52:27Z",
53          "end": "2024-09-06T14:20:27.304000Z",
54          "timer": false
55        },
56        "discount_applied": true,
57        "is_active": true,
58        "stage": "verified",
59        "tags": []
60      }
61    ]
62  }
63}

application/location-price/delete/v1

this event is triggered when location 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
prices
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
size
string
Required
Product size (e.g., S, M, L, XL).
item_id
integer
Required
Unique identifier for the item.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
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        "prices"
78      ],
79      "properties": {
80        "prices": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "store",
89              "company",
90              "item_id",
91              "fynd_item_code",
92              "seller_identifier"
93            ],
94            "properties": {
95              "uid": {
96                "type": "string",
97                "description": "Combination of item code and store ID to uniquely identify the article."
98              },
99              "fynd_item_code": {
100                "type": "string",
101                "description": "Fynd's unique internal code for the product."
102              },
103              "seller_identifier": {
104                "type": "string",
105                "description": "Unique identifier used by the seller for the product."
106              },
107              "size": {
108                "type": "string",
109                "description": "Product size (e.g., S, M, L, XL)."
110              },
111              "item_id": {
112                "type": "integer",
113                "description": "Unique identifier for the item."
114              },
115              "company": {
116                "type": "object",
117                "description": "Information about the company producing or selling the product.",
118                "properties": {
119                  "id": {
120                    "type": "integer",
121                    "description": "Unique identifier for the company."
122                  }
123                },
124                "required": [
125                  "id"
126                ]
127              },
128              "brand": {
129                "type": "object",
130                "description": "Details about the product's brand.",
131                "properties": {
132                  "id": {
133                    "type": "integer",
134                    "description": "Unique identifier for the brand."
135                  }
136                },
137                "required": [
138                  "id"
139                ]
140              },
141              "store": {
142                "type": "object",
143                "description": "Information about the store selling the product.",
144                "properties": {
145                  "id": {
146                    "type": "integer",
147                    "description": "Unique identifier for the store."
148                  }
149                },
150                "required": [
151                  "id"
152                ]
153              }
154            }
155          }
156        }
157      }
158    }
159  }
160}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.be76f10c-edd0-11ee-9d9e-024a9286e161"
5    ],
6    "name": "location-price",
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    "prices"
20  ],
21  "payload": {
22    "prices": [
23      {
24        "uid": "19592_000000410243861090",
25        "fynd_item_code": "M1110008A@N6I",
26        "seller_identifier": "000000410243861090",
27        "size": "3XL",
28        "item_id": 7737047,
29        "company": {
30          "id": 46
31        },
32        "brand": {
33          "id": 235
34        },
35        "store": {
36          "id": 19592
37        }
38      }
39    ]
40  }
41}

Location quantity

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

Events
application/location-quantity/create/v1
# this event is triggered when location quantity is created
application/location-quantity/update/v1
# this event is triggered when location quantity is updated

application/location-quantity/create/v1

this event is triggered when location quantity 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
quantities
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
size
string
Required
Product size (e.g., S, M, L, XL).
item_id
integer
Required
Unique identifier for the item.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
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|null
Details of damaged stock.
Properties
count
integer
Number of damaged units.
updated_at
string
Timestamp of the last damaged stock update.
not_available
object|null
Information about unavailable stock.
Properties
count
integer
Number of unavailable units.
updated_at
string
Timestamp of the last unavailable stock update.
order_committed
object|null
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
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.
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        "quantities"
78      ],
79      "properties": {
80        "quantities": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "store",
89              "company",
90              "item_id",
91              "date_meta",
92              "quantities",
93              "fynd_item_code",
94              "total_quantity",
95              "seller_identifier"
96            ],
97            "properties": {
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "fynd_item_code": {
103                "type": "string",
104                "description": "Fynd's unique internal code for the product."
105              },
106              "seller_identifier": {
107                "type": "string",
108                "description": "Unique identifier used by the seller for the product."
109              },
110              "size": {
111                "type": "string",
112                "description": "Product size (e.g., S, M, L, XL)."
113              },
114              "item_id": {
115                "type": "integer",
116                "description": "Unique identifier for the item."
117              },
118              "company": {
119                "type": "object",
120                "description": "Information about the company producing or selling the product.",
121                "properties": {
122                  "id": {
123                    "type": "integer",
124                    "description": "Unique identifier for the company."
125                  }
126                },
127                "required": [
128                  "id"
129                ]
130              },
131              "brand": {
132                "type": "object",
133                "description": "Details about the product's brand.",
134                "properties": {
135                  "id": {
136                    "type": "integer",
137                    "description": "Unique identifier for the brand."
138                  }
139                },
140                "required": [
141                  "id"
142                ]
143              },
144              "store": {
145                "type": "object",
146                "description": "Information about the store selling the product.",
147                "properties": {
148                  "id": {
149                    "type": "integer",
150                    "description": "Unique identifier for the store."
151                  }
152                },
153                "required": [
154                  "id"
155                ]
156              },
157              "quantities": {
158                "type": "object",
159                "description": "Information about product quantities, including available and unavailable stock.",
160                "properties": {
161                  "sellable": {
162                    "type": "object",
163                    "description": "Sellable stock information.",
164                    "properties": {
165                      "count": {
166                        "type": "integer",
167                        "description": "Number of sellable units available."
168                      },
169                      "updated_at": {
170                        "type": "string",
171                        "description": "Timestamp of the last sellable stock update."
172                      }
173                    }
174                  },
175                  "damaged": {
176                    "type": [
177                      "object",
178                      "null"
179                    ],
180                    "description": "Details of damaged stock.",
181                    "properties": {
182                      "count": {
183                        "type": "integer",
184                        "description": "Number of damaged units."
185                      },
186                      "updated_at": {
187                        "type": "string",
188                        "description": "Timestamp of the last damaged stock update."
189                      }
190                    }
191                  },
192                  "not_available": {
193                    "type": [
194                      "object",
195                      "null"
196                    ],
197                    "description": "Information about unavailable stock.",
198                    "properties": {
199                      "count": {
200                        "type": "integer",
201                        "description": "Number of unavailable units."
202                      },
203                      "updated_at": {
204                        "type": "string",
205                        "description": "Timestamp of the last unavailable stock update."
206                      }
207                    }
208                  },
209                  "order_committed": {
210                    "type": [
211                      "object",
212                      "null"
213                    ],
214                    "description": "Details of committed orders.",
215                    "properties": {
216                      "count": {
217                        "type": "integer",
218                        "description": "Number of units committed to orders."
219                      },
220                      "updated_at": {
221                        "type": "string",
222                        "description": "Timestamp of the last order committed update."
223                      }
224                    }
225                  }
226                }
227              },
228              "total_quantity": {
229                "type": "integer",
230                "description": "Total quantity available for the product."
231              },
232              "expiration_date": {
233                "type": "string",
234                "description": "Expiration or validity end date for the product."
235              },
236              "date_meta": {
237                "type": "object",
238                "description": "Timestamps for important events in the product's lifecycle.",
239                "properties": {
240                  "created_on": {
241                    "type": "string",
242                    "format": "date-time",
243                    "description": "Date and time when the product was first created."
244                  },
245                  "modified_on": {
246                    "type": "string",
247                    "format": "date-time",
248                    "description": "Last modification timestamp of the product inventory details."
249                  },
250                  "added_on_store": {
251                    "type": "string",
252                    "format": "date-time",
253                    "description": "Date and time when the product was added to the store."
254                  },
255                  "inventory_updated_on": {
256                    "type": "string",
257                    "format": "date-time",
258                    "description": "Last inventory update timestamp."
259                  }
260                }
261              }
262            }
263          }
264        }
265      }
266    }
267  }
268}
Payload Example
1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "quantities"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-quantity",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "create",
19    "version": "1"
20  },
21  "payload": {
22    "quantities": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
30        "date_meta": {
31          "added_on_store": "test",
32          "created_on": "test",
33          "inventory_updated_on": "2024-04-03 11:25:38.723172",
34          "modified_on": "2024-04-03 11:25:38.723172"
35        },
36        "fynd_item_code": "MCOP00015_SKYBLUE",
37        "item_id": 8609293,
38        "quantities": {
39          "damaged": {},
40          "not_available": {},
41          "sellable": {
42            "count": 1,
43            "updated_at": "2024-04-04 06:34:05.297180"
44          }
45        },
46        "total_quantity": 1,
47        "expiration_date": "9998-01-30 23:59:00",
48        "size": "40/1.02M",
49        "store": {
50          "id": 15856
51        },
52        "uid": "15856_MCOP00015_SKYBLUE_40"
53      }
54    ]
55  }
56}

application/location-quantity/update/v1

this event is triggered when location quantity 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
quantities
array of object
Required
Array of Properties
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
size
string
Required
Product size (e.g., S, M, L, XL).
item_id
integer
Required
Unique identifier for the item.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
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|null
Details of damaged stock.
Properties
count
integer
Number of damaged units.
updated_at
string
Timestamp of the last damaged stock update.
not_available
object|null
Information about unavailable stock.
Properties
count
integer
Number of unavailable units.
updated_at
string
Timestamp of the last unavailable stock update.
order_committed
object|null
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
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.
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        "quantities"
78      ],
79      "properties": {
80        "quantities": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "uid",
86              "size",
87              "brand",
88              "store",
89              "company",
90              "item_id",
91              "date_meta",
92              "quantities",
93              "fynd_item_code",
94              "total_quantity",
95              "seller_identifier"
96            ],
97            "properties": {
98              "uid": {
99                "type": "string",
100                "description": "Combination of item code and store ID to uniquely identify the article."
101              },
102              "fynd_item_code": {
103                "type": "string",
104                "description": "Fynd's unique internal code for the product."
105              },
106              "seller_identifier": {
107                "type": "string",
108                "description": "Unique identifier used by the seller for the product."
109              },
110              "size": {
111                "type": "string",
112                "description": "Product size (e.g., S, M, L, XL)."
113              },
114              "item_id": {
115                "type": "integer",
116                "description": "Unique identifier for the item."
117              },
118              "company": {
119                "type": "object",
120                "description": "Information about the company producing or selling the product.",
121                "properties": {
122                  "id": {
123                    "type": "integer",
124                    "description": "Unique identifier for the company."
125                  }
126                },
127                "required": [
128                  "id"
129                ]
130              },
131              "brand": {
132                "type": "object",
133                "description": "Details about the product's brand.",
134                "properties": {
135                  "id": {
136                    "type": "integer",
137                    "description": "Unique identifier for the brand."
138                  }
139                },
140                "required": [
141                  "id"
142                ]
143              },
144              "store": {
145                "type": "object",
146                "description": "Information about the store selling the product.",
147                "properties": {
148                  "id": {
149                    "type": "integer",
150                    "description": "Unique identifier for the store."
151                  }
152                },
153                "required": [
154                  "id"
155                ]
156              },
157              "quantities": {
158                "type": "object",
159                "description": "Information about product quantities, including available and unavailable stock.",
160                "properties": {
161                  "sellable": {
162                    "type": "object",
163                    "description": "Sellable stock information.",
164                    "properties": {
165                      "count": {
166                        "type": "integer",
167                        "description": "Number of sellable units available."
168                      },
169                      "updated_at": {
170                        "type": "string",
171                        "description": "Timestamp of the last sellable stock update."
172                      }
173                    }
174                  },
175                  "damaged": {
176                    "type": [
177                      "object",
178                      "null"
179                    ],
180                    "description": "Details of damaged stock.",
181                    "properties": {
182                      "count": {
183                        "type": "integer",
184                        "description": "Number of damaged units."
185                      },
186                      "updated_at": {
187                        "type": "string",
188                        "description": "Timestamp of the last damaged stock update."
189                      }
190                    }
191                  },
192                  "not_available": {
193                    "type": [
194                      "object",
195                      "null"
196                    ],
197                    "description": "Information about unavailable stock.",
198                    "properties": {
199                      "count": {
200                        "type": "integer",
201                        "description": "Number of unavailable units."
202                      },
203                      "updated_at": {
204                        "type": "string",
205                        "description": "Timestamp of the last unavailable stock update."
206                      }
207                    }
208                  },
209                  "order_committed": {
210                    "type": [
211                      "object",
212                      "null"
213                    ],
214                    "description": "Details of committed orders.",
215                    "properties": {
216                      "count": {
217                        "type": "integer",
218                        "description": "Number of units committed to orders."
219                      },
220                      "updated_at": {
221                        "type": "string",
222                        "description": "Timestamp of the last order committed update."
223                      }
224                    }
225                  }
226                }
227              },
228              "total_quantity": {
229                "type": "integer",
230                "description": "Total quantity available for the product."
231              },
232              "expiration_date": {
233                "type": "string",
234                "description": "Expiration or validity end date for the product."
235              },
236              "date_meta": {
237                "type": "object",
238                "description": "Timestamps for important events in the product's lifecycle.",
239                "properties": {
240                  "created_on": {
241                    "type": "string",
242                    "format": "date-time",
243                    "description": "Date and time when the product was first created."
244                  },
245                  "modified_on": {
246                    "type": "string",
247                    "format": "date-time",
248                    "description": "Last modification timestamp of the product inventory details."
249                  },
250                  "added_on_store": {
251                    "type": "string",
252                    "format": "date-time",
253                    "description": "Date and time when the product was added to the store."
254                  },
255                  "inventory_updated_on": {
256                    "type": "string",
257                    "format": "date-time",
258                    "description": "Last inventory update timestamp."
259                  }
260                }
261              }
262            }
263          }
264        }
265      }
266    }
267  }
268}
Payload Example
1{
2  "application_id": [
3    "625e5411d6a31365b571800a",
4    "*"
5  ],
6  "company_id": 2411,
7  "contains": [
8    "quantities"
9  ],
10  "event": {
11    "category": "application",
12    "created_timestamp": 1712143541216,
13    "id": "eCbEMUrjwV8UnqXRzSbRcCBj8hKZCc3rvqPxIXTZ2rE=",
14    "name": "location-quantity",
15    "trace_id": [
16      "wildrider.e74aa68e-f1ac-11ee-aa5c-ca65ee4ea81f"
17    ],
18    "type": "update",
19    "version": "1"
20  },
21  "payload": {
22    "quantities": [
23      {
24        "brand": {
25          "id": 75
26        },
27        "company": {
28          "id": 2411
29        },
30        "date_meta": {
31          "added_on_store": "test",
32          "created_on": "test",
33          "inventory_updated_on": "2024-04-03 11:25:38.723172",
34          "modified_on": "2024-04-03 11:25:38.723172"
35        },
36        "fynd_item_code": "MCOP00015_SKYBLUE",
37        "item_id": 8609293,
38        "quantities": {
39          "damaged": {},
40          "not_available": {},
41          "sellable": {
42            "count": 1,
43            "updated_at": "2024-04-04 06:34:05.297180"
44          }
45        },
46        "total_quantity": 1,
47        "expiration_date": "9998-01-30 23:59:00",
48        "size": "40/1.02M",
49        "store": {
50          "id": 15856
51        },
52        "uid": "15856_MCOP00015_SKYBLUE_40"
53      }
54    ]
55  }
56}

Order

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

Events
application/order/payment_failed/v1
# This event is triggered when order is payment_failed
application/order/pending/v1
# This event is triggered when order is pending
application/order/placed/v1
# This event is triggered when order is placed

application/order/payment_failed/v1

This event is triggered when order is payment_failed

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
order
object
Required
Order's Information
Properties
meta
object
Meta data related to order
Properties
order_platform
string|null
user
object|null
Purchaser's Details such as name, last name, mobile no. and email
Properties
mobile
string
last_name
string|null
first_name
string|null
status
string|null
State of the order, e.g. placed, confirmed, cancelled
discount
number
Discount received on the shipment
shipments
array of object
Object containing the shipment details
Array of Properties
id
string|null
Unique shipment no. that is auto-generated
bags
array of object
Details of all the products/articles in a shipment
Array of Properties
item
object
Properties
name
string|null
The name of the item being referenced
meta
object
Meta data related to bag item
Properties
group_id
string|null
Group ID of the bag, used in case of promotion/bundle products to group the bags
gift_card
object
docket_number
string|null
Unique Identifier for the bags per shipment
partial_can_ret
boolean
Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)
store
object
Fulfilling store information of the shipment
Properties
name
string|null
Name of the store
discount
number|null
Discount received on the individual bag
quantity
integer|null
Quantity of the bag
article_json
object
Article's attribute information, contains attributes information of the article
Properties
identifier
object
Identifier of the article, contains ean/sku
Properties
ean
string|null
affiliate_meta
object
Sales channel meta data information for the bag
Properties
fynd
object
Properties
fulfilment_identifier
string|null
fulfilment_identifiers_list
array|object
box_type
null
coupon_code
string|null
is_priority
boolean
loyalty_discount
number|null
employee_discount
integer|null
size_level_total_qty
integer|null
brand_calculated_amount
number
Effective selling price - Brand's additional discounts
meta
object
Shipment meta data information
Properties
dp_id
string|null
Delivery Partner id that is going to process the shipment
weight
number|null
Weight of the shipment
external
object|null
formatted
object
formatted max and min expected delivery date
Properties
max
string|null
max expected delivery date
min
string|null
min expected delivery date
lock_data
object
Shipment lock information.
Properties
mto
boolean
Made to Order shipment (seller will start production after order placement)
locked
boolean
If shipment is locked or not.
lock_message
string|null
Shipment Lock message, contains reason for locking shipment
timestamp
object
timestamp of expected delivery date
bag_weight
object
debug_info
object
dp_options
object
All available delivery partner options for the the shipment
order_type
string|null
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example: - "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address. - "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person. - "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
dp_sort_key
string|null
parent_dp_id
string|null
shipping_zone
string|null
packaging_name
string|null
shipment_weight
integer
Total weight of the shipment in Grams
assign_dp_from_sb
boolean
same_store_available
boolean
Is Ordering and Fulfilling store are same for the shipemnt
fulfilment_priority_text
string|null
shipment_chargeable_weight
integer
Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater
shipment_volumetric_weight
number|null
Dimensional weight of the shipment, calculated using length, width and height of a package.
auto_trigger_dp_assignment_ACF
boolean
Will Delivery Partner Auto Assigned or not From Stormbreaker
billing_address_json
object
Address by which the invoice is created
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
delivery_address_json
object
Delivery address information
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
coupon_json
object
Applied coupon information
order_value
number|null
Value of the order
affiliate_id
string|null
Sales channel ID
coupon_value
number
Value of the discount being applied by the coupon
payment_mode
object
Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.
Properties
mode
string|null
fynd_order_id
string|null
Unique identifier of the order which is defined by Fynd
app_company_id
integer
Company id of the sales channel
ordering_store
object
Information of the store from which order is initially placed
Properties
code
string|null
delivery_charges
number
The amount charged for delivery apart from the product price
ordering_channel
string|null
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "description": "Order's Information",
83          "properties": {
84            "meta": {
85              "type": "object",
86              "properties": {
87                "order_platform": {
88                  "type": [
89                    "string",
90                    "null"
91                  ]
92                }
93              },
94              "description": "Meta data related to order"
95            },
96            "user": {
97              "type": [
98                "object",
99                "null"
100              ],
101              "properties": {
102                "mobile": {
103                  "type": "string"
104                },
105                "last_name": {
106                  "type": [
107                    "string",
108                    "null"
109                  ]
110                },
111                "first_name": {
112                  "type": [
113                    "string",
114                    "null"
115                  ]
116                }
117              },
118              "description": "Purchaser's Details such as name, last name, mobile no. and email"
119            },
120            "status": {
121              "type": [
122                "string",
123                "null"
124              ],
125              "description": "State of the order, e.g. placed, confirmed, cancelled"
126            },
127            "discount": {
128              "type": "number",
129              "description": "Discount received on the shipment"
130            },
131            "shipments": {
132              "type": "array",
133              "items": {
134                "type": "object",
135                "properties": {
136                  "id": {
137                    "type": [
138                      "string",
139                      "null"
140                    ],
141                    "description": "Unique shipment no. that is auto-generated"
142                  },
143                  "bags": {
144                    "type": "array",
145                    "description": "Details of all the products/articles in a shipment",
146                    "items": {
147                      "type": "object",
148                      "properties": {
149                        "item": {
150                          "type": "object",
151                          "properties": {
152                            "name": {
153                              "type": [
154                                "string",
155                                "null"
156                              ],
157                              "description": "The name of the item being referenced"
158                            }
159                          }
160                        },
161                        "meta": {
162                          "type": "object",
163                          "properties": {
164                            "group_id": {
165                              "type": [
166                                "string",
167                                "null"
168                              ],
169                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
170                            },
171                            "gift_card": {
172                              "type": "object"
173                            },
174                            "docket_number": {
175                              "type": [
176                                "string",
177                                "null"
178                              ],
179                              "description": "Unique Identifier for the bags per shipment"
180                            },
181                            "partial_can_ret": {
182                              "type": "boolean",
183                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
184                            }
185                          },
186                          "description": "Meta data related to bag item"
187                        },
188                        "store": {
189                          "type": "object",
190                          "properties": {
191                            "name": {
192                              "type": [
193                                "string",
194                                "null"
195                              ],
196                              "description": "Name of the store"
197                            }
198                          },
199                          "description": "Fulfilling store information of the shipment"
200                        },
201                        "discount": {
202                          "type": [
203                            "number",
204                            "null"
205                          ],
206                          "description": "Discount received on the individual bag"
207                        },
208                        "quantity": {
209                          "type": [
210                            "integer",
211                            "null"
212                          ],
213                          "description": "Quantity of the bag"
214                        },
215                        "article_json": {
216                          "type": "object",
217                          "properties": {
218                            "identifier": {
219                              "type": "object",
220                              "properties": {
221                                "ean": {
222                                  "type": [
223                                    "string",
224                                    "null"
225                                  ]
226                                }
227                              },
228                              "description": "Identifier of the article, contains ean/sku"
229                            }
230                          },
231                          "description": "Article's attribute information, contains attributes information of the article"
232                        },
233                        "affiliate_meta": {
234                          "type": "object",
235                          "properties": {
236                            "fynd": {
237                              "type": "object",
238                              "properties": {
239                                "fulfilment_identifier": {
240                                  "type": [
241                                    "string",
242                                    "null"
243                                  ]
244                                },
245                                "fulfilment_identifiers_list": {
246                                  "type": [
247                                    "array",
248                                    "object"
249                                  ]
250                                }
251                              }
252                            },
253                            "box_type": {
254                              "type": "null"
255                            },
256                            "coupon_code": {
257                              "type": [
258                                "string",
259                                "null"
260                              ]
261                            },
262                            "is_priority": {
263                              "type": "boolean"
264                            },
265                            "loyalty_discount": {
266                              "type": [
267                                "number",
268                                "null"
269                              ]
270                            },
271                            "employee_discount": {
272                              "type": [
273                                "integer",
274                                "null"
275                              ]
276                            },
277                            "size_level_total_qty": {
278                              "type": [
279                                "integer",
280                                "null"
281                              ]
282                            }
283                          },
284                          "description": "Sales channel meta data information for the bag"
285                        },
286                        "brand_calculated_amount": {
287                          "type": "number",
288                          "description": "Effective selling price  - Brand's additional discounts"
289                        }
290                      }
291                    }
292                  },
293                  "meta": {
294                    "type": "object",
295                    "properties": {
296                      "dp_id": {
297                        "type": [
298                          "string",
299                          "null"
300                        ],
301                        "description": "Delivery Partner id that is going to process the shipment"
302                      },
303                      "weight": {
304                        "type": [
305                          "number",
306                          "null"
307                        ],
308                        "description": "Weight of the shipment"
309                      },
310                      "external": {
311                        "type": [
312                          "object",
313                          "null"
314                        ]
315                      },
316                      "formatted": {
317                        "type": "object",
318                        "properties": {
319                          "max": {
320                            "type": [
321                              "string",
322                              "null"
323                            ],
324                            "description": "max expected delivery date"
325                          },
326                          "min": {
327                            "type": [
328                              "string",
329                              "null"
330                            ],
331                            "description": "min expected delivery date"
332                          }
333                        },
334                        "description": "formatted max and min expected delivery date"
335                      },
336                      "lock_data": {
337                        "type": "object",
338                        "properties": {
339                          "mto": {
340                            "type": "boolean",
341                            "description": "Made to Order shipment (seller will start production after order placement)"
342                          },
343                          "locked": {
344                            "type": "boolean",
345                            "description": "If shipment is locked or not."
346                          },
347                          "lock_message": {
348                            "type": [
349                              "string",
350                              "null"
351                            ],
352                            "description": "Shipment Lock message, contains reason for locking shipment"
353                          }
354                        },
355                        "description": "Shipment lock information."
356                      },
357                      "timestamp": {
358                        "type": "object",
359                        "description": "timestamp of expected delivery date"
360                      },
361                      "bag_weight": {
362                        "type": "object"
363                      },
364                      "debug_info": {
365                        "type": "object"
366                      },
367                      "dp_options": {
368                        "type": "object",
369                        "description": "All available delivery partner options for the the shipment"
370                      },
371                      "order_type": {
372                        "type": [
373                          "string",
374                          "null"
375                        ],
376                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically. \n"
377                      },
378                      "dp_sort_key": {
379                        "type": [
380                          "string",
381                          "null"
382                        ]
383                      },
384                      "parent_dp_id": {
385                        "type": [
386                          "string",
387                          "null"
388                        ]
389                      },
390                      "shipping_zone": {
391                        "type": [
392                          "string",
393                          "null"
394                        ]
395                      },
396                      "packaging_name": {
397                        "type": [
398                          "string",
399                          "null"
400                        ]
401                      },
402                      "shipment_weight": {
403                        "type": "integer",
404                        "description": "Total weight of the shipment in Grams"
405                      },
406                      "assign_dp_from_sb": {
407                        "type": "boolean"
408                      },
409                      "same_store_available": {
410                        "type": "boolean",
411                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
412                      },
413                      "fulfilment_priority_text": {
414                        "type": [
415                          "string",
416                          "null"
417                        ]
418                      },
419                      "shipment_chargeable_weight": {
420                        "type": "integer",
421                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
422                      },
423                      "shipment_volumetric_weight": {
424                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
425                        "type": [
426                          "number",
427                          "null"
428                        ]
429                      },
430                      "auto_trigger_dp_assignment_ACF": {
431                        "type": "boolean",
432                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
433                      }
434                    },
435                    "description": "Shipment meta data information"
436                  },
437                  "billing_address_json": {
438                    "type": "object",
439                    "properties": {
440                      "area": {
441                        "type": [
442                          "string",
443                          "null"
444                        ]
445                      },
446                      "city": {
447                        "type": [
448                          "string",
449                          "null"
450                        ]
451                      },
452                      "name": {
453                        "type": [
454                          "string",
455                          "null"
456                        ]
457                      },
458                      "email": {
459                        "type": [
460                          "string",
461                          "null"
462                        ]
463                      },
464                      "phone": {
465                        "type": [
466                          "string",
467                          "null"
468                        ]
469                      },
470                      "state": {
471                        "type": [
472                          "string",
473                          "null"
474                        ]
475                      },
476                      "address": {
477                        "type": [
478                          "string",
479                          "null"
480                        ]
481                      },
482                      "country": {
483                        "type": [
484                          "string",
485                          "null"
486                        ]
487                      },
488                      "pincode": {
489                        "type": [
490                          "string",
491                          "null"
492                        ]
493                      },
494                      "version": {
495                        "type": [
496                          "string",
497                          "null"
498                        ]
499                      },
500                      "address1": {
501                        "type": [
502                          "string",
503                          "null"
504                        ]
505                      },
506                      "address2": {
507                        "type": [
508                          "string",
509                          "null"
510                        ]
511                      },
512                      "landmark": {
513                        "type": [
514                          "string",
515                          "null"
516                        ]
517                      },
518                      "latitude": {
519                        "type": "number"
520                      },
521                      "area_code": {
522                        "type": [
523                          "string",
524                          "null"
525                        ]
526                      },
527                      "longitude": {
528                        "type": "number"
529                      },
530                      "created_at": {
531                        "type": [
532                          "string",
533                          "null"
534                        ]
535                      },
536                      "updated_at": {
537                        "type": [
538                          "string",
539                          "null"
540                        ]
541                      },
542                      "address_type": {
543                        "type": [
544                          "string",
545                          "null"
546                        ]
547                      },
548                      "contact_person": {
549                        "type": [
550                          "string",
551                          "null"
552                        ]
553                      },
554                      "address_category": {
555                        "type": [
556                          "string",
557                          "null"
558                        ]
559                      }
560                    },
561                    "description": "Address by which the invoice is created"
562                  },
563                  "delivery_address_json": {
564                    "type": "object",
565                    "properties": {
566                      "area": {
567                        "type": [
568                          "string",
569                          "null"
570                        ]
571                      },
572                      "city": {
573                        "type": [
574                          "string",
575                          "null"
576                        ]
577                      },
578                      "name": {
579                        "type": [
580                          "string",
581                          "null"
582                        ]
583                      },
584                      "email": {
585                        "type": [
586                          "string",
587                          "null"
588                        ]
589                      },
590                      "phone": {
591                        "type": [
592                          "string",
593                          "null"
594                        ]
595                      },
596                      "state": {
597                        "type": [
598                          "string",
599                          "null"
600                        ]
601                      },
602                      "address": {
603                        "type": [
604                          "string",
605                          "null"
606                        ]
607                      },
608                      "country": {
609                        "type": [
610                          "string",
611                          "null"
612                        ]
613                      },
614                      "pincode": {
615                        "type": [
616                          "string",
617                          "null"
618                        ]
619                      },
620                      "version": {
621                        "type": [
622                          "string",
623                          "null"
624                        ]
625                      },
626                      "address1": {
627                        "type": [
628                          "string",
629                          "null"
630                        ]
631                      },
632                      "address2": {
633                        "type": [
634                          "string",
635                          "null"
636                        ]
637                      },
638                      "landmark": {
639                        "type": [
640                          "string",
641                          "null"
642                        ]
643                      },
644                      "latitude": {
645                        "type": "number"
646                      },
647                      "area_code": {
648                        "type": [
649                          "string",
650                          "null"
651                        ]
652                      },
653                      "longitude": {
654                        "type": "number"
655                      },
656                      "created_at": {
657                        "type": [
658                          "string",
659                          "null"
660                        ]
661                      },
662                      "updated_at": {
663                        "type": [
664                          "string",
665                          "null"
666                        ]
667                      },
668                      "address_type": {
669                        "type": [
670                          "string",
671                          "null"
672                        ]
673                      },
674                      "contact_person": {
675                        "type": [
676                          "string",
677                          "null"
678                        ]
679                      },
680                      "address_category": {
681                        "type": [
682                          "string",
683                          "null"
684                        ]
685                      }
686                    },
687                    "description": "Delivery address information"
688                  }
689                }
690              },
691              "description": "Object containing the shipment details"
692            },
693            "coupon_json": {
694              "type": "object",
695              "description": "Applied coupon information"
696            },
697            "order_value": {
698              "type": [
699                "number",
700                "null"
701              ],
702              "description": "Value of the order"
703            },
704            "affiliate_id": {
705              "type": [
706                "string",
707                "null"
708              ],
709              "description": "Sales channel ID"
710            },
711            "coupon_value": {
712              "type": "number",
713              "description": "Value of the discount being applied by the coupon"
714            },
715            "payment_mode": {
716              "type": "object",
717              "properties": {
718                "mode": {
719                  "type": [
720                    "string",
721                    "null"
722                  ]
723                }
724              },
725              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
726            },
727            "fynd_order_id": {
728              "type": [
729                "string",
730                "null"
731              ],
732              "description": "Unique identifier of the order which is defined by Fynd"
733            },
734            "app_company_id": {
735              "type": "integer",
736              "description": "Company id of the sales channel"
737            },
738            "ordering_store": {
739              "type": "object",
740              "properties": {
741                "code": {
742                  "type": [
743                    "string",
744                    "null"
745                  ]
746                }
747              },
748              "description": "Information of the store from which order is initially placed"
749            },
750            "delivery_charges": {
751              "type": "number",
752              "description": "The amount charged for delivery apart from the product price"
753            },
754            "ordering_channel": {
755              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.",
756              "type": [
757                "string",
758                "null"
759              ]
760            },
761            "ordering_source": {
762              "type": "string",
763              "nullable": true,
764              "enum": [
765                "storefront",
766                "store_os_pos",
767                "kiosk",
768                "scan_go",
769                "smart_trolley",
770                "gofynd",
771                "uniket",
772                "marketplace",
773                "social_commerce",
774                "ondc",
775                "nexus"
776              ],
777              "description": "To uniquely identify the source through which order has been placed."
778            }
779          }
780        }
781      }
782    }
783  }
784}
Payload Example
1{
2  "application_id": "62692eafbdaef6a37a1bf655",
3  "company_id": 2683,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712162539925,
10    "id": "e5kIwt3E5ufv3ef6GoGNdUDs0gksIE7gf2lzYoRgXGQ=",
11    "name": "order",
12    "trace_id": [
13      "997e8583a02212d19ee9d0557201cbbe"
14    ],
15    "type": "payment_failed",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "62692eafbdaef6a37a1bf655",
21      "cart_info": {
22        "cart_id": 34742656,
23        "cart_object_id": "660d862b3050b38aaf0e9e66",
24        "cart_uid": 34742656
25      },
26      "company_id": 2683,
27      "coupon": {
28        "coupon_value": 0
29      },
30      "meta": {
31        "billing_staff_details": {
32          "employee_code": null,
33          "first_name": null,
34          "id": null,
35          "last_name": null,
36          "user": null
37        },
38        "cart_id": 34742656,
39        "cart_object_id": "660d862b3050b38aaf0e9e66",
40        "comment": "",
41        "company_logo": "/company/2683/applications/62692eafbdaef6a37a1bf655/application/pictures/free-logo/original/Y-jbdLeDF-Suresh-Fashion-Hub.png",
42        "conversion_rate": {
43          "base": "INR",
44          "rates": {
45            "INR": {
46              "name": "Indian Rupee",
47              "sub_unit": "Paisa",
48              "symbol": "₹",
49              "value": 1
50            }
51          },
52          "timestamp": 1712102400000
53        },
54        "currency": {
55          "currency_code": "INR",
56          "currency_name": "Indian Rupee",
57          "currency_sub_unit": "Paisa",
58          "currency_symbol": "₹"
59        },
60        "currency_symbol": "₹",
61        "custom_cart": {},
62        "custom_meta": [],
63        "device_id": null,
64        "employee_id": null,
65        "extra_meta": {},
66        "files": [],
67        "mode": "live",
68        "mongo_cart_id": 34742656,
69        "order_child_entities": [
70          "shipment",
71          "bag"
72        ],
73        "order_platform": "platform-site",
74        "order_tags": [],
75        "order_type": "HomeDelivery",
76        "ordering_store": null,
77        "payment_type": "partner",
78        "platform_user_details": {
79          "platform_user_employee_code": null,
80          "platform_user_first_name": "",
81          "platform_user_id": null,
82          "platform_user_last_name": ""
83        },
84        "sales_channel_logo": "/company/2683/applications/62692eafbdaef6a37a1bf655/application/pictures/free-logo/original/Y-jbdLeDF-Suresh-Fashion-Hub.png",
85        "seller_details": {
86          "country_code": "IN",
87          "currency": {
88            "code": "INR",
89            "name": "Indian Rupee",
90            "symbol": "Rs."
91          },
92          "timezone": "Asia/Kolkata"
93        },
94        "staff": {},
95        "transaction_data": {
96          "amount": 1025,
97          "id": "order_NuDeNS2ki7LLiE",
98          "merchant_order_id": "FY660D86CD0EF92B2804",
99          "status": "BAD_REQUEST_ERROR"
100        },
101        "usable_credit_notes": []
102      },
103      "order_id": "FY660D86CD0EF92B2804",
104      "payment": {
105        "payment_mode": {
106          "mode": "UPI"
107        },
108        "price_breakup": {
109          "delivery_charges": 75,
110          "discount": 0,
111          "order_value": 1025
112        }
113      },
114      "payment_methods": {
115        "UPI": {
116          "amount": 1025,
117          "collect_by": "seller",
118          "meta": {
119            "aggregator": "Razorpay",
120            "id": "order_NuDeNS2ki7LLiE",
121            "logo_url": {
122              "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/RlegqhCD_-upi_150x100.png",
123              "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/AXPZr4jPW-upi_100x78.png"
124            },
125            "merchant_code": "UPI",
126            "order_id": "FY660D86CD0EF92B2804",
127            "payment_gateway": "Razorpay",
128            "payment_id": null,
129            "payment_identifier": "test@ybl",
130            "transaction_id": null,
131            "transaction_timestamp": null
132          },
133          "mode": "UPI",
134          "name": "UPI",
135          "prices": {
136            "amount": {
137              "amount": [
138                {
139                  "currency_code": "INR",
140                  "value": 1025
141                }
142              ],
143              "is_refundable": true,
144              "taxable_amount": [
145                {
146                  "currency_code": "INR",
147                  "value": 1025
148                }
149              ],
150              "taxes": []
151            }
152          },
153          "refund_by": "seller"
154        }
155      },
156      "shipments": [
157        {
158          "bags": [
159            {
160              "affiliate_meta": {
161                "box_type": null,
162                "channel_order_id": null,
163                "channel_shipment_id": null,
164                "coupon_code": null,
165                "due_date": null,
166                "employee_discount": 0,
167                "fynd": {
168                  "fulfilment_identifier": "pulse",
169                  "fulfilment_identifiers_list": [
170                    "pulse"
171                  ]
172                },
173                "is_priority": false,
174                "loyalty_discount": 0,
175                "size_level_total_qty": 1
176              },
177              "article_json": {
178                "_id": "64b9336424cc5ee5326eb0b5",
179                "article_code": "",
180                "article_data_population_from_ACF": "current",
181                "article_history_ACF": [
182                  {
183                    "_id": "64b9336424cc5ee5326eb0b5",
184                    "last_updated_at_ACF": "2024-04-02 11:39:43.293832",
185                    "store_id": 15236
186                  }
187                ],
188                "article_type_ACF": "individual",
189                "available_article_count": 6,
190                "brand_id": 4081,
191                "cancellation_allowed": true,
192                "child_details": {},
193                "company_id": 2683,
194                "currency": {
195                  "code": "INR",
196                  "rate": 1
197                },
198                "dimension": {
199                  "height": 4,
200                  "is_default": true,
201                  "length": 24,
202                  "unit": "cm",
203                  "width": 20
204                },
205                "discount_percentage": 29.629629629629623,
206                "esp_modified": false,
207                "expiration_date": "9998-01-30 23:59:00",
208                "fragile": false,
209                "group_id": "",
210                "hsn_code": "58063200",
211                "hsn_code_id": "627783795e4c6fdbc8be3e38",
212                "identifier": {
213                  "sku_code": "17620(1)"
214                },
215                "is_gift": false,
216                "is_set": false,
217                "item_id": 9497845,
218                "last_updated_at_ACF": "2024-04-02 11:39:43.293805",
219                "manufacturing_time": 0,
220                "manufacturing_time_unit": "hours",
221                "mto_quantity": 0,
222                "price_effective": 950,
223                "price_marked": 1350,
224                "quantity": 1,
225                "return_allowed": false,
226                "return_config": {
227                  "returnable": false,
228                  "time": 0,
229                  "unit": "days"
230                },
231                "seller_identifier": "17620(1)",
232                "set": {},
233                "set_quantity": 1,
234                "size": "PACK OF 9  METERS",
235                "source_ACF": "MegatronCart",
236                "store_id": 15236,
237                "transfer_price": 0,
238                "weight": {
239                  "is_default": true,
240                  "shipping": 0.56,
241                  "unit": "gram"
242                }
243              },
244              "brand_calculated_amount": 950,
245              "discount": 400,
246              "item": {
247                "attributes": {
248                  "brand_name": "Suresh Fashion Hub India.",
249                  "essential": "No",
250                  "gender": [
251                    "Unisex"
252                  ],
253                  "marketer-address": "test address",
254                  "marketer-name": "Suresh Fashion Hub India",
255                  "media": [],
256                  "name": "Light Orange Magnolia Designer Trim",
257                  "net-quantity": "1 N",
258                  "primary-colour-hex-code": "EB8D1D",
259                  "primary_color": "Orange",
260                  "primary_color_hex": "EB8D1D"
261                },
262                "branch_url": null,
263                "brand": "Suresh Fashion Hub India.",
264                "brand_id": 4081,
265                "can_cancel": true,
266                "can_return": true,
267                "code": "17620(1)",
268                "color": null,
269                "gender": null,
270                "id": 9497845,
271                "images": [
272                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/1O-Hyh-Qc-Light-Orange-Magnolia-Designer-Trim.jpeg",
273                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/GFnSA3Xq_-Light-Orange-Magnolia-Designer-Trim.jpeg",
274                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/9x4Hl5plj-Light-Orange-Magnolia-Designer-Trim.jpeg"
275                ],
276                "l1_category": [
277                  "Accessories"
278                ],
279                "l1_category_id": 31,
280                "l2_category": [
281                  "Designer Accessories"
282                ],
283                "l2_category_id": 3320,
284                "l3_category": 3321,
285                "l3_category_name": "Designer Laces",
286                "last_updated_at": "2024-04-03T22:11:51+00:00",
287                "meta": {
288                  "departments": [
289                    21
290                  ],
291                  "tags": []
292                },
293                "name": "Light Orange Magnolia Designer Trim",
294                "slug_key": "light-orange-magnolia-designer-trim-9497845",
295                "webstore_product_url": null
296              },
297              "quantity": 1,
298              "store": {
299                "code": "HS-737a8"
300              }
301            }
302          ],
303          "billing_address_json": {
304            "address": ", test",
305            "address1": "test address",
306            "address2": "",
307            "address_category": "",
308            "address_type": "Home",
309            "area": "",
310            "area_code": "110085",
311            "area_code_slug": "pincode",
312            "city": "North Delhi",
313            "contact_person": "test test",
314            "country": "India",
315            "country_code": "+91",
316            "country_iso_code": "IN",
317            "country_phone_code": "+91",
318            "created_at": "2024-04-03 22:11:51",
319            "delivery_address_id": 5787609,
320            "display_address": " 110085\nIndia",
321            "email": "test@example.com",
322            "geo_location": {
323              "latitude": 28.7153451,
324              "longitude": 77.1088008
325            },
326            "id": "660d864e0e96a5f038a2a602",
327            "landmark": "",
328            "latitude": 28.7153451,
329            "longitude": 77.1088008,
330            "name": "test",
331            "phone": "1111111111",
332            "pincode": "110085",
333            "sector": "",
334            "state": "Delhi",
335            "state_code": "",
336            "uid": 5787609,
337            "updated_at": "2024-04-03 22:11:51",
338            "user_id": null,
339            "version": "1.0"
340          },
341          "delivery_address_json": {
342            "address": ", test addresss",
343            "address1": ", test address",
344            "address2": "",
345            "address_category": "",
346            "address_type": "Home",
347            "area": "",
348            "area_code": "110085",
349            "area_code_slug": "pincode",
350            "city": "North Delhi",
351            "contact_person": "test test",
352            "country": "India",
353            "country_code": "+91",
354            "country_iso_code": "IN",
355            "country_phone_code": "+91",
356            "created_at": "2024-04-03 22:11:51",
357            "delivery_address_id": 5787609,
358            "display_address": "Sector 11, Rohini\nNorth Delhi Delhi 110085\nIndia",
359            "email": "test@example.com",
360            "geo_location": {
361              "latitude": 28.7153451,
362              "longitude": 77.1088008
363            },
364            "id": "660d864e0e96a5f038a2a602",
365            "landmark": "",
366            "latitude": 28.7153451,
367            "longitude": 77.1088008,
368            "name": "Yashita Aggarwal",
369            "phone": "1111111111",
370            "pincode": "110085",
371            "sector": "",
372            "state": "Delhi",
373            "state_code": "",
374            "uid": 5787609,
375            "updated_at": "2024-04-03 22:11:51",
376            "user_id": null,
377            "version": "1.0"
378          },
379          "id": "17121625110871139641"
380        }
381      ],
382      "status": "payment_failed",
383      "user": {
384        "is_anonymous_user": true
385      }
386    }
387  }
388}

application/order/pending/v1

This event is triggered when order is pending

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
order
object
Required
Order's Information
Properties
meta
object
Properties
order_platform
string|null
Platform from where order is placed. marketplace/platform-site/platform-pos
user
object|null
Purchaser's Details such as name, last name, mobile no. and email
Properties
mobile
string
last_name
string|null
first_name
string|null
status
string|null
State of the order, e.g. placed, confirmed, cancelled
discount
number
Discount received on the shipment
shipments
array of object
Object containing the shipment details
Array of Properties
id
string|null
Unique shipment no. that is auto-generated
bags
array of object
Details of all the products/articles in a shipment
Array of Properties
item
object
Properties
name
string|null
The name of the item being referenced
meta
object
Meta data related to bag item
Properties
group_id
string|null
Group ID of the bag, used in case of promotion/bundle products to group the bags
gift_card
object
docket_number
string|null
Unique Identifier for the bags per shipment
partial_can_ret
boolean
Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)
store
object
Fulfilling store information related of the shipment
Properties
name
string|null
Name of the store
discount
number|null
Discount received on the individual bag
quantity
integer|null
Quantity of the bag
article_json
object
Article's attribute information, contains attributes information of the article
Properties
identifier
object
Product Identifier details, contains ean/sku
Properties
ean
string|null
affiliate_meta
object
Sales channel meta data information for the bag
Properties
fynd
object
Properties
fulfilment_identifier
string|null
fulfilment_identifiers_list
array|object
box_type
null
coupon_code
string|null
is_priority
boolean
loyalty_discount
number|null
employee_discount
integer|null
size_level_total_qty
integer|null
brand_calculated_amount
number
Effective selling price - Brand's additional discounts
meta
object
Shipment meta data information
Properties
dp_id
string|null
Delivery Partner id that is going to process the shipment
weight
number|null
Weight of the shipment
external
object|null
formatted
object
formatted max and min expected delivery date
Properties
max
string|null
max expected delivery date
min
string|null
min expected delivery date
lock_data
object
Shipment lock information.
Properties
mto
boolean
Made to Order shipment (seller will start production after order placement)
locked
boolean
If shipment is locked or not.
lock_message
string|null
Shipment Lock message, contains reason for locking shipment
timestamp
object
timestamp of expected delivery date
bag_weight
object
debug_info
object
dp_options
object
All available delivery partner options for the the shipment
order_type
string|null
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example: - "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address. - "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person. - "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
dp_sort_key
string|null
parent_dp_id
string|null
shipping_zone
string|null
packaging_name
string|null
shipment_weight
integer
Total weight of the shipment in Grams
assign_dp_from_sb
boolean
same_store_available
boolean
Is Ordering and Fulfilling store are same for the shipemnt
fulfilment_priority_text
string|null
shipment_chargeable_weight
integer
Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater
shipment_volumetric_weight
number|null
Dimensional weight of the shipment, calculated using length, width and height of a package.
auto_trigger_dp_assignment_ACF
boolean
Will Delivery Partner Auto Assigned or not From Stormbreaker
billing_address_json
object
Address by which the invoice is created
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
delivery_address_json
object
Delivery address information
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
coupon_json
object
Applied coupon information
order_value
number|null
Value of the order
affiliate_id
string|null
Sales channel ID
coupon_value
number
Value of the discount being applied by the coupon
payment_mode
object
Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.
Properties
mode
string|null
fynd_order_id
string|null
Unique identifier of the order which is defined by Fynd
app_company_id
integer
Company id of the sales channel
ordering_store
object
Information of the store from which order is initially placed
Properties
code
string|null
delivery_charges
number
The amount charged for delivery apart from the product price
ordering_channel
string|null
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "properties": {
83            "meta": {
84              "type": "object",
85              "properties": {
86                "order_platform": {
87                  "type": [
88                    "string",
89                    "null"
90                  ],
91                  "description": "Platform from where order is placed. marketplace/platform-site/platform-pos"
92                }
93              }
94            },
95            "user": {
96              "type": [
97                "object",
98                "null"
99              ],
100              "properties": {
101                "mobile": {
102                  "type": "string"
103                },
104                "last_name": {
105                  "type": [
106                    "string",
107                    "null"
108                  ]
109                },
110                "first_name": {
111                  "type": [
112                    "string",
113                    "null"
114                  ]
115                }
116              },
117              "description": "Purchaser's Details such as name, last name, mobile no. and email"
118            },
119            "status": {
120              "type": [
121                "string",
122                "null"
123              ],
124              "description": "State of the order, e.g. placed, confirmed, cancelled"
125            },
126            "discount": {
127              "type": "number",
128              "description": "Discount received on the shipment"
129            },
130            "shipments": {
131              "type": "array",
132              "items": {
133                "type": "object",
134                "properties": {
135                  "id": {
136                    "type": [
137                      "string",
138                      "null"
139                    ],
140                    "description": "Unique shipment no. that is auto-generated"
141                  },
142                  "bags": {
143                    "type": "array",
144                    "description": "Details of all the products/articles in a shipment",
145                    "items": {
146                      "type": "object",
147                      "properties": {
148                        "item": {
149                          "type": "object",
150                          "properties": {
151                            "name": {
152                              "type": [
153                                "string",
154                                "null"
155                              ],
156                              "description": "The name of the item being referenced"
157                            }
158                          }
159                        },
160                        "meta": {
161                          "type": "object",
162                          "properties": {
163                            "group_id": {
164                              "type": [
165                                "string",
166                                "null"
167                              ],
168                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
169                            },
170                            "gift_card": {
171                              "type": "object"
172                            },
173                            "docket_number": {
174                              "type": [
175                                "string",
176                                "null"
177                              ],
178                              "description": "Unique Identifier for the bags per shipment"
179                            },
180                            "partial_can_ret": {
181                              "type": "boolean",
182                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
183                            }
184                          },
185                          "description": "Meta data related to bag item"
186                        },
187                        "store": {
188                          "type": "object",
189                          "properties": {
190                            "name": {
191                              "type": [
192                                "string",
193                                "null"
194                              ],
195                              "description": "Name of the store"
196                            }
197                          },
198                          "description": "Fulfilling store information related of the shipment"
199                        },
200                        "discount": {
201                          "type": [
202                            "number",
203                            "null"
204                          ],
205                          "description": "Discount received on the individual bag"
206                        },
207                        "quantity": {
208                          "type": [
209                            "integer",
210                            "null"
211                          ],
212                          "description": "Quantity of the bag"
213                        },
214                        "article_json": {
215                          "type": "object",
216                          "properties": {
217                            "identifier": {
218                              "type": "object",
219                              "properties": {
220                                "ean": {
221                                  "type": [
222                                    "string",
223                                    "null"
224                                  ]
225                                }
226                              },
227                              "description": "Product Identifier details, contains ean/sku"
228                            }
229                          },
230                          "description": "Article's attribute information, contains attributes information of the article"
231                        },
232                        "affiliate_meta": {
233                          "type": "object",
234                          "properties": {
235                            "fynd": {
236                              "type": "object",
237                              "properties": {
238                                "fulfilment_identifier": {
239                                  "type": [
240                                    "string",
241                                    "null"
242                                  ]
243                                },
244                                "fulfilment_identifiers_list": {
245                                  "type": [
246                                    "array",
247                                    "object"
248                                  ]
249                                }
250                              }
251                            },
252                            "box_type": {
253                              "type": "null"
254                            },
255                            "coupon_code": {
256                              "type": [
257                                "string",
258                                "null"
259                              ]
260                            },
261                            "is_priority": {
262                              "type": "boolean"
263                            },
264                            "loyalty_discount": {
265                              "type": [
266                                "number",
267                                "null"
268                              ]
269                            },
270                            "employee_discount": {
271                              "type": [
272                                "integer",
273                                "null"
274                              ]
275                            },
276                            "size_level_total_qty": {
277                              "type": [
278                                "integer",
279                                "null"
280                              ]
281                            }
282                          },
283                          "description": "Sales channel meta data information for the bag"
284                        },
285                        "brand_calculated_amount": {
286                          "type": "number",
287                          "description": "Effective selling price  - Brand's additional discounts"
288                        }
289                      }
290                    }
291                  },
292                  "meta": {
293                    "type": "object",
294                    "properties": {
295                      "dp_id": {
296                        "type": [
297                          "string",
298                          "null"
299                        ],
300                        "description": "Delivery Partner id that is going to process the shipment"
301                      },
302                      "weight": {
303                        "type": [
304                          "number",
305                          "null"
306                        ],
307                        "description": "Weight of the shipment"
308                      },
309                      "external": {
310                        "type": [
311                          "object",
312                          "null"
313                        ]
314                      },
315                      "formatted": {
316                        "type": "object",
317                        "properties": {
318                          "max": {
319                            "type": [
320                              "string",
321                              "null"
322                            ],
323                            "description": "max expected delivery date"
324                          },
325                          "min": {
326                            "type": [
327                              "string",
328                              "null"
329                            ],
330                            "description": "min expected delivery date"
331                          }
332                        },
333                        "description": "formatted max and min expected delivery date"
334                      },
335                      "lock_data": {
336                        "type": "object",
337                        "properties": {
338                          "mto": {
339                            "type": "boolean",
340                            "description": "Made to Order shipment (seller will start production after order placement)"
341                          },
342                          "locked": {
343                            "type": "boolean",
344                            "description": "If shipment is locked or not."
345                          },
346                          "lock_message": {
347                            "type": [
348                              "string",
349                              "null"
350                            ],
351                            "description": "Shipment Lock message, contains reason for locking shipment"
352                          }
353                        },
354                        "description": "Shipment lock information."
355                      },
356                      "timestamp": {
357                        "type": "object",
358                        "description": "timestamp of expected delivery date"
359                      },
360                      "bag_weight": {
361                        "type": "object"
362                      },
363                      "debug_info": {
364                        "type": "object"
365                      },
366                      "dp_options": {
367                        "type": "object",
368                        "description": "All available delivery partner options for the the shipment"
369                      },
370                      "order_type": {
371                        "type": [
372                          "string",
373                          "null"
374                        ],
375                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.\n"
376                      },
377                      "dp_sort_key": {
378                        "type": [
379                          "string",
380                          "null"
381                        ]
382                      },
383                      "parent_dp_id": {
384                        "type": [
385                          "string",
386                          "null"
387                        ]
388                      },
389                      "shipping_zone": {
390                        "type": [
391                          "string",
392                          "null"
393                        ]
394                      },
395                      "packaging_name": {
396                        "type": [
397                          "string",
398                          "null"
399                        ]
400                      },
401                      "shipment_weight": {
402                        "type": "integer",
403                        "description": "Total weight of the shipment in Grams"
404                      },
405                      "assign_dp_from_sb": {
406                        "type": "boolean"
407                      },
408                      "same_store_available": {
409                        "type": "boolean",
410                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
411                      },
412                      "fulfilment_priority_text": {
413                        "type": [
414                          "string",
415                          "null"
416                        ]
417                      },
418                      "shipment_chargeable_weight": {
419                        "type": "integer",
420                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
421                      },
422                      "shipment_volumetric_weight": {
423                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
424                        "type": [
425                          "number",
426                          "null"
427                        ]
428                      },
429                      "auto_trigger_dp_assignment_ACF": {
430                        "type": "boolean",
431                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
432                      }
433                    },
434                    "description": "Shipment meta data information"
435                  },
436                  "billing_address_json": {
437                    "type": "object",
438                    "properties": {
439                      "area": {
440                        "type": [
441                          "string",
442                          "null"
443                        ]
444                      },
445                      "city": {
446                        "type": [
447                          "string",
448                          "null"
449                        ]
450                      },
451                      "name": {
452                        "type": [
453                          "string",
454                          "null"
455                        ]
456                      },
457                      "email": {
458                        "type": [
459                          "string",
460                          "null"
461                        ]
462                      },
463                      "phone": {
464                        "type": [
465                          "string",
466                          "null"
467                        ]
468                      },
469                      "state": {
470                        "type": [
471                          "string",
472                          "null"
473                        ]
474                      },
475                      "address": {
476                        "type": [
477                          "string",
478                          "null"
479                        ]
480                      },
481                      "country": {
482                        "type": [
483                          "string",
484                          "null"
485                        ]
486                      },
487                      "pincode": {
488                        "type": [
489                          "string",
490                          "null"
491                        ]
492                      },
493                      "version": {
494                        "type": [
495                          "string",
496                          "null"
497                        ]
498                      },
499                      "address1": {
500                        "type": [
501                          "string",
502                          "null"
503                        ]
504                      },
505                      "address2": {
506                        "type": [
507                          "string",
508                          "null"
509                        ]
510                      },
511                      "landmark": {
512                        "type": [
513                          "string",
514                          "null"
515                        ]
516                      },
517                      "latitude": {
518                        "type": "number"
519                      },
520                      "area_code": {
521                        "type": [
522                          "string",
523                          "null"
524                        ]
525                      },
526                      "longitude": {
527                        "type": "number"
528                      },
529                      "created_at": {
530                        "type": [
531                          "string",
532                          "null"
533                        ]
534                      },
535                      "updated_at": {
536                        "type": [
537                          "string",
538                          "null"
539                        ]
540                      },
541                      "address_type": {
542                        "type": [
543                          "string",
544                          "null"
545                        ]
546                      },
547                      "contact_person": {
548                        "type": [
549                          "string",
550                          "null"
551                        ]
552                      },
553                      "address_category": {
554                        "type": [
555                          "string",
556                          "null"
557                        ]
558                      }
559                    },
560                    "description": "Address by which the invoice is created"
561                  },
562                  "delivery_address_json": {
563                    "type": "object",
564                    "properties": {
565                      "area": {
566                        "type": [
567                          "string",
568                          "null"
569                        ]
570                      },
571                      "city": {
572                        "type": [
573                          "string",
574                          "null"
575                        ]
576                      },
577                      "name": {
578                        "type": [
579                          "string",
580                          "null"
581                        ]
582                      },
583                      "email": {
584                        "type": [
585                          "string",
586                          "null"
587                        ]
588                      },
589                      "phone": {
590                        "type": [
591                          "string",
592                          "null"
593                        ]
594                      },
595                      "state": {
596                        "type": [
597                          "string",
598                          "null"
599                        ]
600                      },
601                      "address": {
602                        "type": [
603                          "string",
604                          "null"
605                        ]
606                      },
607                      "country": {
608                        "type": [
609                          "string",
610                          "null"
611                        ]
612                      },
613                      "pincode": {
614                        "type": [
615                          "string",
616                          "null"
617                        ]
618                      },
619                      "version": {
620                        "type": [
621                          "string",
622                          "null"
623                        ]
624                      },
625                      "address1": {
626                        "type": [
627                          "string",
628                          "null"
629                        ]
630                      },
631                      "address2": {
632                        "type": [
633                          "string",
634                          "null"
635                        ]
636                      },
637                      "landmark": {
638                        "type": [
639                          "string",
640                          "null"
641                        ]
642                      },
643                      "latitude": {
644                        "type": "number"
645                      },
646                      "area_code": {
647                        "type": [
648                          "string",
649                          "null"
650                        ]
651                      },
652                      "longitude": {
653                        "type": "number"
654                      },
655                      "created_at": {
656                        "type": [
657                          "string",
658                          "null"
659                        ]
660                      },
661                      "updated_at": {
662                        "type": [
663                          "string",
664                          "null"
665                        ]
666                      },
667                      "address_type": {
668                        "type": [
669                          "string",
670                          "null"
671                        ]
672                      },
673                      "contact_person": {
674                        "type": [
675                          "string",
676                          "null"
677                        ]
678                      },
679                      "address_category": {
680                        "type": [
681                          "string",
682                          "null"
683                        ]
684                      }
685                    },
686                    "description": "Delivery address information"
687                  }
688                }
689              },
690              "description": "Object containing the shipment details"
691            },
692            "coupon_json": {
693              "type": "object",
694              "description": "Applied coupon information"
695            },
696            "order_value": {
697              "type": [
698                "number",
699                "null"
700              ],
701              "description": "Value of the order"
702            },
703            "affiliate_id": {
704              "type": [
705                "string",
706                "null"
707              ],
708              "description": "Sales channel ID"
709            },
710            "coupon_value": {
711              "type": "number",
712              "description": "Value of the discount being applied by the coupon"
713            },
714            "payment_mode": {
715              "type": "object",
716              "properties": {
717                "mode": {
718                  "type": [
719                    "string",
720                    "null"
721                  ]
722                }
723              },
724              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
725            },
726            "fynd_order_id": {
727              "type": [
728                "string",
729                "null"
730              ],
731              "description": "Unique identifier of the order which is defined by Fynd"
732            },
733            "app_company_id": {
734              "type": "integer",
735              "description": "Company id of the sales channel"
736            },
737            "ordering_store": {
738              "type": "object",
739              "properties": {
740                "code": {
741                  "type": [
742                    "string",
743                    "null"
744                  ]
745                }
746              },
747              "description": "Information of the store from which order is initially placed"
748            },
749            "delivery_charges": {
750              "type": "number",
751              "description": "The amount charged for delivery apart from the product price"
752            },
753            "ordering_channel": {
754              "type": [
755                "string",
756                "null"
757              ],
758              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
759            },
760            "ordering_source": {
761              "type": "string",
762              "nullable": true,
763              "enum": [
764                "storefront",
765                "store_os_pos",
766                "kiosk",
767                "scan_go",
768                "smart_trolley",
769                "gofynd",
770                "uniket",
771                "marketplace",
772                "social_commerce",
773                "ondc",
774                "nexus"
775              ],
776              "description": "To uniquely identify the source through which order has been placed."
777            }
778          },
779          "description": "Order's Information"
780        }
781      }
782    }
783  }
784}
Payload Example
1{
2  "application_id": "63f893a94adb0bbd79de0344",
3  "company_id": 4641,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712163281916,
10    "id": "NTb9VHA1Kw+COIF9TbM07XmJHqUCkxS7Q9cwUIFZjbQ=",
11    "name": "order",
12    "trace_id": [
13      "0000000000000000dadf1f76b2d8e452"
14    ],
15    "type": "pending",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "63f893a94adb0bbd79de0344",
21      "cart_info": {
22        "cart_uid": 1000000007
23      },
24      "company_id": 4641,
25      "coupon": {
26        "coupon_value": 0
27      },
28      "meta": {
29        "billing_staff_details": {},
30        "charges": [
31          {
32            "amount": {
33              "currency": "INR",
34              "value": 0
35            },
36            "code": "",
37            "name": "COD Charges",
38            "type": "cod_charges"
39          },
40          {
41            "amount": {
42              "currency": "INR",
43              "value": 0
44            },
45            "code": "",
46            "name": "Delivery Charges",
47            "type": "delivery_charges"
48          }
49        ],
50        "company_logo": null,
51        "conversion_rate": {
52          "base": "INR",
53          "rates": {
54            "INR": {
55              "name": "Indian Rupee",
56              "sub_unit": "Paisa",
57              "symbol": "₹",
58              "value": 1
59            }
60          },
61          "timestamp": 1712057944.367167
62        },
63        "currency": {
64          "currency_code": "INR",
65          "currency_name": "Indian Rupee",
66          "currency_sub_unit": "Paisa",
67          "currency_symbol": "₹"
68        },
69        "currency_info": {},
70        "employee_id": "",
71        "external_creation_date": "1712183080",
72        "extra_meta": {},
73        "mongo_cart_id": 1000000007,
74        "order_child_entities": [
75          "bag",
76          "shipment"
77        ],
78        "order_type": "new",
79        "ordering_channel_logo": "",
80        "ordering_store": null,
81        "payment_type": null,
82        "platform_user_details": {},
83        "sales_channel_logo": "",
84        "seller_details": {},
85        "staff": {}
86      },
87      "order_id": "FYMP660D89D10161D965",
88      "payment": {
89        "payment_mode": {
90          "mode": "PP"
91        },
92        "price_breakup": {
93          "delivery_charges": 0,
94          "discount": 0,
95          "order_value": 0
96        }
97      },
98      "payment_methods": {
99        "PP": {
100          "amount": 0,
101          "collect_by": "seller",
102          "meta": {},
103          "mode": "PP",
104          "name": "PartnerPay",
105          "refund_by": "seller"
106        },
107        "Prepaid_Payments": {
108          "amount": 51.8,
109          "collect_by": "seller",
110          "meta": {},
111          "mode": "Prepaid_Payments",
112          "name": "Prepaid_Payments",
113          "refund_by": "seller"
114        }
115      },
116      "shipments": [
117        {
118          "bags": [
119            {
120              "affiliate_meta": {
121                "box_type": null,
122                "channel_order_id": null,
123                "channel_shipment_id": null,
124                "coupon_code": null,
125                "due_date": null,
126                "employee_discount": 0,
127                "fynd": {
128                  "fulfilment_identifier": "pulse",
129                  "fulfilment_identifiers_list": [
130                    "pulse"
131                  ]
132                },
133                "is_priority": false,
134                "loyalty_discount": 0,
135                "size_level_total_qty": null
136              },
137              "article_json": {
138                "_id": "64977dde20b77e320db1587d",
139                "article_code": "",
140                "article_data_population_from_ACF": "current",
141                "article_history_ACF": [
142                  {
143                    "_id": "64977dde20b77e320db1587d",
144                    "last_updated_at_ACF": "2024-04-02 11:39:05.512352",
145                    "store_id": 20091
146                  }
147                ],
148                "article_type_ACF": "individual",
149                "available_article_count": 1695,
150                "brand_id": "",
151                "cancellation_allowed": true,
152                "child_details": {},
153                "company_id": 4641,
154                "currency": {},
155                "dimension": {},
156                "discount_percentage": 131,
157                "esp_modified": "",
158                "expiration_date": null,
159                "fragile": "",
160                "group_id": "",
161                "hsn_code": "20081100",
162                "hsn_code_id": "627782b45e4c6fdbc8be2a1e",
163                "identifier": {
164                  "sku_code": "O12502_1"
165                },
166                "is_gift": false,
167                "is_set": "",
168                "item_id": 9378052,
169                "last_updated_at_ACF": "2024-04-02 11:39:05.512328",
170                "manufacturing_time": 0,
171                "manufacturing_time_unit": "hours",
172                "mto_quantity": "",
173                "price_effective": 518,
174                "price_marked": 649,
175                "quantity": 1,
176                "return_allowed": true,
177                "return_config": {
178                  "returnable": true,
179                  "time": 1,
180                  "unit": "days"
181                },
182                "seller_identifier": "O12502_1",
183                "set": {},
184                "set_quantity": 1,
185                "size": "L",
186                "source_ACF": "MegatronCart",
187                "store_id": 20091,
188                "transfer_price": 0,
189                "weight": {}
190              },
191              "brand_calculated_amount": 518,
192              "discount": 131,
193              "item": {
194                "attributes": {
195                  "brand_name": "Myfitness",
196                  "essential": "No",
197                  "marketer-address": "test adderss0",
198                  "marketer-name": "TANVI Healthcare",
199                  "media": [],
200                  "name": "MyFitness Original crunchy Peanut Butter 1250 gms",
201                  "net-quantity": "1 N"
202                },
203                "branch_url": null,
204                "brand": "Myfitness",
205                "brand_id": 6113,
206                "can_cancel": true,
207                "can_return": true,
208                "code": "RVHNNNVN7Q",
209                "color": null,
210                "gender": null,
211                "id": 9378052,
212                "images": [
213                  "https://fynd-static.s3.amazonaws.com/common/default_item_image.jpg"
214                ],
215                "l1_category": [
216                  "Beverages"
217                ],
218                "l1_category_id": 1876,
219                "l2_category": [
220                  "Energy & Soft Drinks"
221                ],
222                "l2_category_id": 1902,
223                "l3_category": 2078,
224                "l3_category_name": "Aerated Drinks",
225                "last_updated_at": "2024-04-03T22:24:42+00:00",
226                "meta": {
227                  "departments": [
228                    18
229                  ],
230                  "tags": []
231                },
232                "name": "MyFitness Original crunchy Peanut Butter 1250 gms",
233                "slug_key": "myfitness-original-crunchy-peanut-butter-1250-gms-9378052",
234                "webstore_product_url": null
235              },
236              "quantity": 1,
237              "store": {
238                "code": "3PPBZXSO7FC10"
239              }
240            }
241          ],
242          "billing_address_json": {
243            "address": "  test address",
244            "address1": " test address",
245            "address2": "",
246            "address_category": "",
247            "address_type": "home",
248            "area": "",
249            "area_code": "",
250            "area_code_slug": "",
251            "city": "Sonipat",
252            "contact_person": "test test ",
253            "country": "India",
254            "country_iso_code": "IN",
255            "country_phone_code": null,
256            "created_at": "2024-04-03 22:24:41",
257            "display_address": " 131001\nIndia",
258            "email": "test@example.com",
259            "first_name": "test test",
260            "geo_location": {},
261            "landmark": "",
262            "last_name": "",
263            "latitude": 0,
264            "longitude": 0,
265            "name": "",
266            "phone": "1111111111",
267            "pincode": "131001",
268            "state": "Haryana",
269            "updated_at": "2024-04-03 22:24:41",
270            "version": "1.0"
271          },
272          "delivery_address_json": {
273            "address": "  electric works",
274            "address1": " electric works\nSonipat Haryana 131001\nIndia",
275            "address2": "",
276            "address_category": "",
277            "address_type": "home",
278            "area": "",
279            "area_code": "",
280            "area_code_slug": "",
281            "city": "Sonipat",
282            "contact_person": "test test ",
283            "country": "India",
284            "country_iso_code": "IN",
285            "country_phone_code": null,
286            "created_at": "2024-04-03 22:24:41",
287            "display_address": " electric works\nSonipat Haryana 131001\nIndia",
288            "email": "test@example.com",
289            "first_name": "test test",
290            "geo_location": {},
291            "landmark": "",
292            "last_name": "",
293            "latitude": 0,
294            "longitude": 0,
295            "name": "",
296            "phone": "1111111111",
297            "pincode": "131001",
298            "state": "Haryana",
299            "updated_at": "2024-04-03 22:24:41",
300            "user_id": 18245977,
301            "version": "1.0"
302          },
303          "id": "17121632817081880021"
304        }
305      ],
306      "status": "pending",
307      "user": {
308        "email": "test@example.com",
309        "external_customer_id": null,
310        "first_name": "test test",
311        "gender": null,
312        "id": 18245977,
313        "is_anonymous_user": false,
314        "last_name": "",
315        "meta": {
316          "country_phone_code": ""
317        },
318        "mobile": "1111111111",
319        "mongo_user_id": null,
320        "user_oid": null
321      }
322    }
323  }
324}

application/order/placed/v1

This event is triggered when order is placed

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
order
object
Required
Order's Information
Properties
meta
object
Properties
order_platform
string|null
user
object|null
Purchaser's Details such as name, last name, mobile no. and email
Properties
mobile
string
last_name
string|null
first_name
string|null
status
string|null
State of the order, e.g. placed, confirmed, cancelled
discount
number
Discount received on the shipment
shipments
array of object
Object containing the shipment details
Array of Properties
id
string|null
bags
array of object
Details of all the products/articles in a shipment
Array of Properties
item
object
Properties
name
string|null
The name of the item being referenced
meta
object
Meta data related to bag item
Properties
group_id
string|null
Group ID of the bag, used in case of promotion/bundle products to group the bags
gift_card
object
docket_number
string|null
Unique Identifier for the bags per shipment
partial_can_ret
boolean
Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)
store
object
Fulfilling store information related of the shipment
Properties
name
string|null
Name of the store
discount
number|null
Discount received on the individual bag
quantity
integer|null
Quantity of the bag
article_json
object
Article's attribute information, contains attributes information of the article
Properties
identifier
object
Product Identifier details, contains ean/sku
Properties
ean
string|null
affiliate_meta
object
Sales channel meta data information for the bag
Properties
fynd
object
Properties
fulfilment_identifier
string|null
fulfilment_identifiers_list
array|object
box_type
null
coupon_code
string|null
is_priority
boolean
loyalty_discount
number|null
employee_discount
integer|null
size_level_total_qty
integer|null
brand_calculated_amount
number
Effective selling price - Brand's additional discounts
meta
object
Shipment meta data information
Properties
dp_id
string|null
Delivery Partner id that is going to process the shipment
weight
number|null
Weight of the shipment
external
object|null
formatted
object
formatted max and min expected delivery date
Properties
max
string|null
max expected delivery date
min
string|null
min expected delivery date
lock_data
object
Shipment lock information.
Properties
mto
boolean
Made to Order shipment (seller will start production after order placement)
locked
boolean
If shipment is locked or not.
lock_message
string|null
Shipment Lock message, contains reason for locking shipment
timestamp
object
timestamp of expected delivery date
bag_weight
object
debug_info
object
dp_options
object
All available delivery partner options for the the shipment
order_type
string|null
Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example: - "HomeDelivery": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address. - "PickAtStore": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person. - "Digital": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically.
dp_sort_key
string|null
parent_dp_id
string|null
shipping_zone
string|null
packaging_name
string|null
shipment_weight
integer
Total weight of the shipment in Grams
assign_dp_from_sb
boolean
same_store_available
boolean
Is Ordering and Fulfilling store are same for the shipemnt
fulfilment_priority_text
string|null
shipment_chargeable_weight
integer
Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater
shipment_volumetric_weight
number|null
Dimensional weight of the shipment, calculated using length, width and height of a package.
auto_trigger_dp_assignment_ACF
boolean
Will Delivery Partner Auto Assigned or not From Stormbreaker
billing_address_json
object
Address by which the invoice is created
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
delivery_address_json
object
Delivery address information
Properties
area
string|null
city
string|null
name
string|null
email
string|null
phone
string|null
state
string|null
address
string|null
country
string|null
pincode
string|null
version
string|null
address1
string|null
address2
string|null
landmark
string|null
latitude
number
area_code
string|null
longitude
number
created_at
string|null
updated_at
string|null
address_type
string|null
contact_person
string|null
address_category
string|null
coupon_json
object
Applied coupon information
order_value
number|null
Value of the order
affiliate_id
string|null
Sales channel ID
coupon_value
number
Value of the discount being applied by the coupon
payment_mode
object
Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc.
Properties
mode
string|null
fynd_order_id
string|null
Unique identifier of the order which is defined by Fynd
app_company_id
integer
Company id of the sales channel
ordering_store
object
Information of the store from which order is initially placed
Properties
code
string|null
delivery_charges
number
The amount charged for delivery apart from the product price
ordering_channel
string|null
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
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        "order"
78      ],
79      "properties": {
80        "order": {
81          "type": "object",
82          "properties": {
83            "meta": {
84              "type": "object",
85              "properties": {
86                "order_platform": {
87                  "type": [
88                    "string",
89                    "null"
90                  ]
91                }
92              }
93            },
94            "user": {
95              "type": [
96                "object",
97                "null"
98              ],
99              "properties": {
100                "mobile": {
101                  "type": "string"
102                },
103                "last_name": {
104                  "type": [
105                    "string",
106                    "null"
107                  ]
108                },
109                "first_name": {
110                  "type": [
111                    "string",
112                    "null"
113                  ]
114                }
115              },
116              "description": "Purchaser's Details such as name, last name, mobile no. and email"
117            },
118            "status": {
119              "type": [
120                "string",
121                "null"
122              ],
123              "description": "State of the order, e.g. placed, confirmed, cancelled"
124            },
125            "discount": {
126              "type": "number",
127              "description": "Discount received on the shipment"
128            },
129            "shipments": {
130              "type": "array",
131              "items": {
132                "type": "object",
133                "properties": {
134                  "id": {
135                    "type": [
136                      "string",
137                      "null"
138                    ]
139                  },
140                  "bags": {
141                    "type": "array",
142                    "description": "Details of all the products/articles in a shipment",
143                    "items": {
144                      "type": "object",
145                      "properties": {
146                        "item": {
147                          "type": "object",
148                          "properties": {
149                            "name": {
150                              "type": [
151                                "string",
152                                "null"
153                              ],
154                              "description": "The name of the item being referenced"
155                            }
156                          }
157                        },
158                        "meta": {
159                          "type": "object",
160                          "properties": {
161                            "group_id": {
162                              "type": [
163                                "string",
164                                "null"
165                              ],
166                              "description": "Group ID of the bag, used in case of promotion/bundle products to group the bags"
167                            },
168                            "gift_card": {
169                              "type": "object"
170                            },
171                            "docket_number": {
172                              "type": [
173                                "string",
174                                "null"
175                              ],
176                              "description": "Unique Identifier for the bags per shipment"
177                            },
178                            "partial_can_ret": {
179                              "type": "boolean",
180                              "description": "Boolean to indicate if promotion applied bag can be partially returned (if multiple bags are part of same promotion)"
181                            }
182                          },
183                          "description": "Meta data related to bag item"
184                        },
185                        "store": {
186                          "type": "object",
187                          "properties": {
188                            "name": {
189                              "type": [
190                                "string",
191                                "null"
192                              ],
193                              "description": "Name of the store"
194                            }
195                          },
196                          "description": "Fulfilling store information related of the shipment"
197                        },
198                        "discount": {
199                          "type": [
200                            "number",
201                            "null"
202                          ],
203                          "description": "Discount received on the individual bag"
204                        },
205                        "quantity": {
206                          "type": [
207                            "integer",
208                            "null"
209                          ],
210                          "description": "Quantity of the bag"
211                        },
212                        "article_json": {
213                          "type": "object",
214                          "properties": {
215                            "identifier": {
216                              "type": "object",
217                              "properties": {
218                                "ean": {
219                                  "type": [
220                                    "string",
221                                    "null"
222                                  ]
223                                }
224                              },
225                              "description": "Product Identifier details, contains ean/sku"
226                            }
227                          },
228                          "description": "Article's attribute information, contains attributes information of the article"
229                        },
230                        "affiliate_meta": {
231                          "type": "object",
232                          "properties": {
233                            "fynd": {
234                              "type": "object",
235                              "properties": {
236                                "fulfilment_identifier": {
237                                  "type": [
238                                    "string",
239                                    "null"
240                                  ]
241                                },
242                                "fulfilment_identifiers_list": {
243                                  "type": [
244                                    "array",
245                                    "object"
246                                  ]
247                                }
248                              }
249                            },
250                            "box_type": {
251                              "type": "null"
252                            },
253                            "coupon_code": {
254                              "type": [
255                                "string",
256                                "null"
257                              ]
258                            },
259                            "is_priority": {
260                              "type": "boolean"
261                            },
262                            "loyalty_discount": {
263                              "type": [
264                                "number",
265                                "null"
266                              ]
267                            },
268                            "employee_discount": {
269                              "type": [
270                                "integer",
271                                "null"
272                              ]
273                            },
274                            "size_level_total_qty": {
275                              "type": [
276                                "integer",
277                                "null"
278                              ]
279                            }
280                          },
281                          "description": "Sales channel meta data information for the bag"
282                        },
283                        "brand_calculated_amount": {
284                          "type": "number",
285                          "description": "Effective selling price  - Brand's additional discounts"
286                        }
287                      }
288                    }
289                  },
290                  "meta": {
291                    "type": "object",
292                    "properties": {
293                      "dp_id": {
294                        "type": [
295                          "string",
296                          "null"
297                        ],
298                        "description": "Delivery Partner id that is going to process the shipment"
299                      },
300                      "weight": {
301                        "type": [
302                          "number",
303                          "null"
304                        ],
305                        "description": "Weight of the shipment"
306                      },
307                      "external": {
308                        "type": [
309                          "object",
310                          "null"
311                        ]
312                      },
313                      "formatted": {
314                        "type": "object",
315                        "properties": {
316                          "max": {
317                            "type": [
318                              "string",
319                              "null"
320                            ],
321                            "description": "max expected delivery date"
322                          },
323                          "min": {
324                            "type": [
325                              "string",
326                              "null"
327                            ],
328                            "description": "min expected delivery date"
329                          }
330                        },
331                        "description": "formatted max and min expected delivery date"
332                      },
333                      "lock_data": {
334                        "type": "object",
335                        "properties": {
336                          "mto": {
337                            "type": "boolean",
338                            "description": "Made to Order shipment (seller will start production after order placement)"
339                          },
340                          "locked": {
341                            "type": "boolean",
342                            "description": "If shipment is locked or not."
343                          },
344                          "lock_message": {
345                            "type": [
346                              "string",
347                              "null"
348                            ],
349                            "description": "Shipment Lock message, contains reason for locking shipment"
350                          }
351                        },
352                        "description": "Shipment lock information."
353                      },
354                      "timestamp": {
355                        "type": "object",
356                        "description": "timestamp of expected delivery date"
357                      },
358                      "bag_weight": {
359                        "type": "object"
360                      },
361                      "debug_info": {
362                        "type": "object"
363                      },
364                      "dp_options": {
365                        "type": "object",
366                        "description": "All available delivery partner options for the the shipment"
367                      },
368                      "order_type": {
369                        "type": [
370                          "string",
371                          "null"
372                        ],
373                        "description": "Defines the specific journey a shipment will follow based on the application's operational needs and customer preferences. This field categorizes orders into distinct types, each associated with a unique processing flow. For example:\n- \"HomeDelivery\": The order goes through all the steps needed for delivery, from being packed to arriving at the customer’s address.\n- \"PickAtStore\": The order is prepared for pickup at the store, skipping shipping steps to make it ready faster for the customer to collect in person.\n- \"Digital\": This order type likely refers to orders that involve digital goods or services, such as software, digital subscriptions, e-books, online courses, or any other item that can be delivered electronically. \n"
374                      },
375                      "dp_sort_key": {
376                        "type": [
377                          "string",
378                          "null"
379                        ]
380                      },
381                      "parent_dp_id": {
382                        "type": [
383                          "string",
384                          "null"
385                        ]
386                      },
387                      "shipping_zone": {
388                        "type": [
389                          "string",
390                          "null"
391                        ]
392                      },
393                      "packaging_name": {
394                        "type": [
395                          "string",
396                          "null"
397                        ]
398                      },
399                      "shipment_weight": {
400                        "type": "integer",
401                        "description": "Total weight of the shipment in Grams"
402                      },
403                      "assign_dp_from_sb": {
404                        "type": "boolean"
405                      },
406                      "same_store_available": {
407                        "type": "boolean",
408                        "description": "Is Ordering and Fulfilling store are same for the shipemnt"
409                      },
410                      "fulfilment_priority_text": {
411                        "type": [
412                          "string",
413                          "null"
414                        ]
415                      },
416                      "shipment_chargeable_weight": {
417                        "type": "integer",
418                        "description": "Either be the gross weight (actual weight) or the volumetric weight (dimensional weight), whichever is greater"
419                      },
420                      "shipment_volumetric_weight": {
421                        "description": "Dimensional weight of the shipment, calculated using length, width and height of a package.",
422                        "type": [
423                          "number",
424                          "null"
425                        ]
426                      },
427                      "auto_trigger_dp_assignment_ACF": {
428                        "type": "boolean",
429                        "description": "Will Delivery Partner Auto Assigned or not From Stormbreaker"
430                      }
431                    },
432                    "description": "Shipment meta data information"
433                  },
434                  "billing_address_json": {
435                    "type": "object",
436                    "properties": {
437                      "area": {
438                        "type": [
439                          "string",
440                          "null"
441                        ]
442                      },
443                      "city": {
444                        "type": [
445                          "string",
446                          "null"
447                        ]
448                      },
449                      "name": {
450                        "type": [
451                          "string",
452                          "null"
453                        ]
454                      },
455                      "email": {
456                        "type": [
457                          "string",
458                          "null"
459                        ]
460                      },
461                      "phone": {
462                        "type": [
463                          "string",
464                          "null"
465                        ]
466                      },
467                      "state": {
468                        "type": [
469                          "string",
470                          "null"
471                        ]
472                      },
473                      "address": {
474                        "type": [
475                          "string",
476                          "null"
477                        ]
478                      },
479                      "country": {
480                        "type": [
481                          "string",
482                          "null"
483                        ]
484                      },
485                      "pincode": {
486                        "type": [
487                          "string",
488                          "null"
489                        ]
490                      },
491                      "version": {
492                        "type": [
493                          "string",
494                          "null"
495                        ]
496                      },
497                      "address1": {
498                        "type": [
499                          "string",
500                          "null"
501                        ]
502                      },
503                      "address2": {
504                        "type": [
505                          "string",
506                          "null"
507                        ]
508                      },
509                      "landmark": {
510                        "type": [
511                          "string",
512                          "null"
513                        ]
514                      },
515                      "latitude": {
516                        "type": "number"
517                      },
518                      "area_code": {
519                        "type": [
520                          "string",
521                          "null"
522                        ]
523                      },
524                      "longitude": {
525                        "type": "number"
526                      },
527                      "created_at": {
528                        "type": [
529                          "string",
530                          "null"
531                        ]
532                      },
533                      "updated_at": {
534                        "type": [
535                          "string",
536                          "null"
537                        ]
538                      },
539                      "address_type": {
540                        "type": [
541                          "string",
542                          "null"
543                        ]
544                      },
545                      "contact_person": {
546                        "type": [
547                          "string",
548                          "null"
549                        ]
550                      },
551                      "address_category": {
552                        "type": [
553                          "string",
554                          "null"
555                        ]
556                      }
557                    },
558                    "description": "Address by which the invoice is created"
559                  },
560                  "delivery_address_json": {
561                    "type": "object",
562                    "properties": {
563                      "area": {
564                        "type": [
565                          "string",
566                          "null"
567                        ]
568                      },
569                      "city": {
570                        "type": [
571                          "string",
572                          "null"
573                        ]
574                      },
575                      "name": {
576                        "type": [
577                          "string",
578                          "null"
579                        ]
580                      },
581                      "email": {
582                        "type": [
583                          "string",
584                          "null"
585                        ]
586                      },
587                      "phone": {
588                        "type": [
589                          "string",
590                          "null"
591                        ]
592                      },
593                      "state": {
594                        "type": [
595                          "string",
596                          "null"
597                        ]
598                      },
599                      "address": {
600                        "type": [
601                          "string",
602                          "null"
603                        ]
604                      },
605                      "country": {
606                        "type": [
607                          "string",
608                          "null"
609                        ]
610                      },
611                      "pincode": {
612                        "type": [
613                          "string",
614                          "null"
615                        ]
616                      },
617                      "version": {
618                        "type": [
619                          "string",
620                          "null"
621                        ]
622                      },
623                      "address1": {
624                        "type": [
625                          "string",
626                          "null"
627                        ]
628                      },
629                      "address2": {
630                        "type": [
631                          "string",
632                          "null"
633                        ]
634                      },
635                      "landmark": {
636                        "type": [
637                          "string",
638                          "null"
639                        ]
640                      },
641                      "latitude": {
642                        "type": "number"
643                      },
644                      "area_code": {
645                        "type": [
646                          "string",
647                          "null"
648                        ]
649                      },
650                      "longitude": {
651                        "type": "number"
652                      },
653                      "created_at": {
654                        "type": [
655                          "string",
656                          "null"
657                        ]
658                      },
659                      "updated_at": {
660                        "type": [
661                          "string",
662                          "null"
663                        ]
664                      },
665                      "address_type": {
666                        "type": [
667                          "string",
668                          "null"
669                        ]
670                      },
671                      "contact_person": {
672                        "type": [
673                          "string",
674                          "null"
675                        ]
676                      },
677                      "address_category": {
678                        "type": [
679                          "string",
680                          "null"
681                        ]
682                      }
683                    },
684                    "description": "Delivery address information"
685                  }
686                }
687              },
688              "description": "Object containing the shipment details"
689            },
690            "coupon_json": {
691              "type": "object",
692              "description": "Applied coupon information"
693            },
694            "order_value": {
695              "type": [
696                "number",
697                "null"
698              ],
699              "description": "Value of the order"
700            },
701            "affiliate_id": {
702              "type": [
703                "string",
704                "null"
705              ],
706              "description": "Sales channel ID"
707            },
708            "coupon_value": {
709              "type": "number",
710              "description": "Value of the discount being applied by the coupon"
711            },
712            "payment_mode": {
713              "type": "object",
714              "properties": {
715                "mode": {
716                  "type": [
717                    "string",
718                    "null"
719                  ]
720                }
721              },
722              "description": "Mode of payment. Possible values: NB, UPI, Wallet, Card, COD etc."
723            },
724            "fynd_order_id": {
725              "type": [
726                "string",
727                "null"
728              ],
729              "description": "Unique identifier of the order which is defined by Fynd"
730            },
731            "app_company_id": {
732              "type": "integer",
733              "description": "Company id of the sales channel"
734            },
735            "ordering_store": {
736              "type": "object",
737              "properties": {
738                "code": {
739                  "type": [
740                    "string",
741                    "null"
742                  ]
743                }
744              },
745              "description": "Information of the store from which order is initially placed"
746            },
747            "delivery_charges": {
748              "type": "number",
749              "description": "The amount charged for delivery apart from the product price"
750            },
751            "ordering_channel": {
752              "type": [
753                "string",
754                "null"
755              ],
756              "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
757            },
758            "ordering_source": {
759              "type": "string",
760              "nullable": true,
761              "enum": [
762                "storefront",
763                "store_os_pos",
764                "kiosk",
765                "scan_go",
766                "smart_trolley",
767                "gofynd",
768                "uniket",
769                "marketplace",
770                "social_commerce",
771                "ondc",
772                "nexus"
773              ],
774              "description": "To uniquely identify the source through which order has been placed."
775            }
776          },
777          "description": "Order's Information"
778        }
779      }
780    }
781  }
782}
Payload Example
1{
2  "application_id": "6523fa5f41f4eb4c10a1d869",
3  "company_id": 5842,
4  "contains": [
5    "order"
6  ],
7  "event": {
8    "category": "application",
9    "created_timestamp": 1712163424658,
10    "id": "etVPYls7l5mgn0Rb099RC3/nxuQhbEZGFM2eFfPpRqE=",
11    "name": "order",
12    "trace_id": [
13      "926446ee7a99153939756f1847c66861"
14    ],
15    "type": "placed",
16    "version": "1"
17  },
18  "payload": {
19    "order": {
20      "application_id": "6523fa5f41f4eb4c10a1d869",
21      "cart_info": {
22        "cart_id": 50646042,
23        "cart_object_id": "660d889a54680fcda603b401",
24        "cart_uid": 50646042
25      },
26      "company_id": 5842,
27      "coupon": {
28        "coupon_value": 0
29      },
30      "meta": {
31        "billing_staff_details": {
32          "employee_code": null,
33          "first_name": null,
34          "id": null,
35          "last_name": null,
36          "user": null
37        },
38        "cart_id": 50646042,
39        "cart_object_id": "660d889a54680fcda603b401",
40        "comment": "",
41        "company_logo": "/company/5842/applications/6523fa5f41f4eb4c10a1d869/application/pictures/free-logo/original/b0ftwtPw4-Sephora-India.webp",
42        "conversion_rate": {
43          "base": "INR",
44          "rates": {
45            "INR": {
46              "name": "Indian Rupee",
47              "sub_unit": "Paisa",
48              "symbol": "₹",
49              "value": 1
50            }
51          },
52          "timestamp": 1712102400000
53        },
54        "currency": {
55          "currency_code": "INR",
56          "currency_name": "Indian Rupee",
57          "currency_sub_unit": "Paisa",
58          "currency_symbol": "₹"
59        },
60        "currency_symbol": "₹",
61        "custom_cart": {},
62        "custom_meta": [],
63        "device_id": null,
64        "employee_id": null,
65        "extra_meta": {},
66        "files": [],
67        "mode": "live",
68        "mongo_cart_id": 50646042,
69        "order_child_entities": [
70          "shipment",
71          "bag"
72        ],
73        "order_platform": "platform-site",
74        "order_tags": [],
75        "order_type": "HomeDelivery",
76        "ordering_store": null,
77        "payment_type": "self",
78        "platform_user_details": {
79          "platform_user_employee_code": null,
80          "platform_user_first_name": "",
81          "platform_user_id": null,
82          "platform_user_last_name": ""
83        },
84        "sales_channel_logo": "/company/5842/applications/6523fa5f41f4eb4c10a1d869/application/pictures/free-logo/original/b0ftwtPw4-Sephora-India.webp",
85        "seller_details": {
86          "country_code": "IN",
87          "currency": {
88            "code": "INR",
89            "name": "Indian Rupee",
90            "symbol": "Rs."
91          },
92          "timezone": "Asia/Kolkata"
93        },
94        "staff": {},
95        "transaction_data": {
96          "acquirer_data": {
97            "auth_code": "838359",
98            "rrn": "409416604309"
99          },
100          "amount": 115000,
101          "amount_refunded": 0,
102          "amount_transferred": 0,
103          "bank": null,
104          "base_amount": 115000,
105          "captured": true,
106          "card": {
107            "emi": false,
108            "entity": "card",
109            "id": "test",
110            "iin": "999999",
111            "international": false,
112            "issuer": "HDFC",
113            "last4": "4144",
114            "name": "",
115            "network": "Visa",
116            "sub_type": "consumer",
117            "type": "debit"
118          },
119          "card_id": "test",
120          "contact": "1111111111",
121          "created_at": 1712163402,
122          "currency": "INR",
123          "customer_id": "test",
124          "description": null,
125          "email": "test@example.com",
126          "entity": "payment",
127          "error_code": "",
128          "error_description": "",
129          "error_reason": null,
130          "error_source": null,
131          "error_step": null,
132          "fee": 2300,
133          "id": "pay_NuDu4hlGdRnSbL",
134          "international": false,
135          "invoice_id": null,
136          "method": "card",
137          "notes": [],
138          "order_id": "order_NuDu3jUVxssZVK",
139          "refund_status": null,
140          "status": "captured",
141          "tax": 0,
142          "vpa": null,
143          "wallet": null
144        },
145        "usable_credit_notes": []
146      },
147      "order_id": "FY660D8A490E9186AD5E",
148      "payment": {
149        "payment_mode": {
150          "mode": "CARD"
151        },
152        "price_breakup": {
153          "delivery_charges": 0,
154          "discount": 0,
155          "order_value": 1150
156        }
157      },
158      "payment_methods": {
159        "CARD": {
160          "amount": 1150,
161          "collect_by": "seller",
162          "meta": {
163            "id": null,
164            "logo_url": {
165              "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/B-dXunCVn-default_card.png",
166              "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/B-dXunCVn-default_card.png"
167            },
168            "merchant_code": "",
169            "payment_gateway": "Razorpay",
170            "payment_id": "FY660D8A490E9186AD5E",
171            "payment_identifier": ""
172          },
173          "mode": "CARD",
174          "name": "CARD",
175          "prices": {
176            "amount": {
177              "amount": [
178                {
179                  "currency_code": "INR",
180                  "value": 1150
181                }
182              ],
183              "is_refundable": true,
184              "taxable_amount": [
185                {
186                  "currency_code": "INR",
187                  "value": 1150
188                }
189              ],
190              "taxes": []
191            }
192          },
193          "refund_by": "seller"
194        }
195      },
196      "shipments": [
197        {
198          "bags": [
199            {
200              "affiliate_meta": {
201                "box_type": null,
202                "channel_order_id": null,
203                "channel_shipment_id": null,
204                "coupon_code": null,
205                "due_date": null,
206                "employee_discount": 0,
207                "fynd": {
208                  "fulfilment_identifier": "pulse",
209                  "fulfilment_identifiers_list": [
210                    "pulse"
211                  ]
212                },
213                "is_priority": false,
214                "loyalty_discount": 0,
215                "size_level_total_qty": 1
216              },
217              "article_json": {
218                "_id": "65aad28f0f3bdaea3c2542d8",
219                "article_code": "",
220                "article_data_population_from_ACF": "current",
221                "article_history_ACF": [
222                  {
223                    "_id": "65aad28f0f3bdaea3c2542d8",
224                    "last_updated_at_ACF": "2024-04-02 11:39:43.293832",
225                    "store_id": 22579
226                  }
227                ],
228                "article_type_ACF": "individual",
229                "available_article_count": 144,
230                "brand_id": 7342,
231                "cancellation_allowed": true,
232                "child_details": {},
233                "company_id": 5842,
234                "currency": {
235                  "code": "INR",
236                  "rate": 1
237                },
238                "dimension": {
239                  "height": 14,
240                  "is_default": true,
241                  "length": 5,
242                  "unit": "cm",
243                  "width": 5
244                },
245                "discount_percentage": 0,
246                "esp_modified": false,
247                "expiration_date": "9998-01-30 23:59:00",
248                "fragile": false,
249                "group_id": "",
250                "hsn_code": "00000001",
251                "hsn_code_id": "000000000000000000000001",
252                "identifier": {
253                  "alu": "000000000494274005",
254                  "ean": "3378872188018"
255                },
256                "is_gift": false,
257                "is_set": false,
258                "item_id": 9791610,
259                "last_updated_at_ACF": "2024-04-02 11:39:43.293805",
260                "manufacturing_time": 0,
261                "manufacturing_time_unit": "hours",
262                "mto_quantity": 0,
263                "price_effective": 1150,
264                "price_marked": 1150,
265                "quantity": 1,
266                "return_allowed": true,
267                "return_config": {
268                  "returnable": true,
269                  "time": 14,
270                  "unit": "days"
271                },
272                "seller_identifier": "000000000494274005",
273                "set": {},
274                "set_quantity": 1,
275                "size": "OS",
276                "source_ACF": "MegatronCart",
277                "store_id": 22579,
278                "transfer_price": 0,
279                "weight": {
280                  "is_default": true,
281                  "shipping": 200,
282                  "unit": "gram"
283                }
284              },
285              "brand_calculated_amount": 1150,
286              "discount": 0,
287              "item": {
288                "attributes": {
289                  "active_ingredients": [
290                    "Anti Oxidants",
291                    "Alcohol Free",
292                    "Oil Free",
293                    "Fragrance Free",
294                    "Vitamins"
295                  ],
296                  "brand_name": "SEPHORA COLLECTION",
297                  "colour-group": [
298                    "Multi"
299                  ],
300                  "custom-attribute-1": "Bath And Body",
301                  "custom-attribute-2": "Moisturiser",
302                  "custom-attribute-3": "Body",
303                  "custom-attribute-4": "Lightly-fragranced skin all day long <br>\nOur Sephora Collection Scented Moisturizing Lotion melts into the skin, leaving it soft, nourished and feeling comfortable. <br> \n<br>\nAvailable in 5 addictive fragrances. <br>\nTolerance dermatologically tested. <br>\n<br>\nFragrances <br>\n- Coconut fragrance: An invitation to a sweet escape, the coconut’s fragrance is a pure bliss. <br>\n- Argan fragrance: Feel the warmth of soothing argan notes that pamper body & mind. <br>\n- Cotton Flower fragrance: Cotton flower notes wrap you in a veil of silky softness. <br>\n- Cherry Blossom fragrance: A soft and sheer fragrance that makes you daydream about Spring’s first blossom. <br>\n- Monoi fragrance: Monoï and hot sand… the most unforgettable summers come rushing back. <br>\n<br>",
304                  "custom-attribute-5": "True",
305                  "custom-attribute-7": [
306                    "Scented Moisturizing Body Lotion"
307                  ],
308                  "custom-attribute-9": [
309                    "20230303"
310                  ],
311                  "essential": "No",
312                  "gender": [
313                    "Women"
314                  ],
315                  "how_to_use": "1. Take a small amount of body lotion </li><br>\n2. Apply to skin and gently massage in until fully absorbed\nUse daily. </li><br></li>",
316                  "ingredients": "Monoi Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Parfum (Fragrance), Carbomer, Chlorphenesin, Limonene, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Cocos Nucifera (Coconut) Oil, Linalool, Tetrasodium Glutamate Diacetate, Citric Acid, Gardenia Tahitensis Flower, Tocopherol.\n\nCherry Blossom Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Citric Acid, Prunus Cerasus (Bitter Cherry) Flower Extract, Sodium Benzoate, Tocopherol.\n\nCoconut Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Cetearyl Alcohol, Parfum (Fragrance), Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Cocos Nucifera (Coconut) Fruit Juice, Citric Acid, Tocopherol, Methyl Anthranilate, Sodium Benzoate, Potassium Sorbate.\n\nCotton Flower Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Citric Acid, Gossypium Herbaceum (Cotton) Extract, Tocopherol, Sodium Benzoate, Potassium Sorbate.\n\nArgan Ingredients : Aqua (Water), Glycerin, Isopropyl Palmitate, Dicaprylyl Ether, Stearic Acid, Palmitic Acid, Parfum (Fragrance), Cetearyl Alcohol, Butyrospermum Parkii Butter (Butyrospermum Parkii (Shea Butter)), Glyceryl Stearate, Caprylyl Glycol, Carbomer, Chlorphenesin, Dipropylene Glycol, Sodium Hydroxide, Glyceryl Caprylate, Tocopheryl Acetate, Tetrasodium Glutamate Diacetate, Methyl Anthranilate, Argania Spinosa Kernel Oil, Citric Acid, Tocopherol.",
317                  "is-primary-variant": "No",
318                  "is-sample-product": "No",
319                  "marketer-address": "test address",
320                  "marketer-name": "Sephora Cosmetics Private limited",
321                  "mask_type": "The formula is vegan</li><li>and contains 96% ingredients of natural origin. <br>A pack developed using a responsible approach: <br> The bottle is made with 43% recycled plastic. <br><br></li><li>Free from animal-derived ingredients</li><li>",
322                  "media": [],
323                  "name": "Scented Moisturizing Body Lotion • Cherry Blossom",
324                  "net-quantity": "1 N",
325                  "pack-size": "Cherry Blossom",
326                  "primary_color": "Multi",
327                  "primary_color_hex": "None",
328                  "product-formula": [
329                    "Lotion"
330                  ]
331                },
332                "branch_url": null,
333                "brand": "SEPHORA COLLECTION",
334                "brand_id": 7342,
335                "can_cancel": true,
336                "can_return": true,
337                "code": "7024780",
338                "color": null,
339                "gender": null,
340                "id": 9791610,
341                "images": [
342                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/XuJCX1gbtc-000000000494274005_1.png",
343                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/57CiG9ItM-000000000494274005_2.jpg",
344                  "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000000494274005/J2-iHBZe7B-000000000494274005_3.jpg"
345                ],
346                "l1_category": [
347                  "Personal Care"
348                ],
349                "l1_category_id": 666,
350                "l2_category": [
351                  "Face Care"
352                ],
353                "l2_category_id": 670,
354                "l3_category": 756,
355                "l3_category_name": "Moisturizer",
356                "last_updated_at": "2024-04-03T22:26:42+00:00",
357                "meta": {
358                  "departments": [
359                    4
360                  ],
361                  "tags": [
362                    "No Discount",
363                    "Bath And Body-Moisturiser",
364                    "Bath And Body-Moisturiser-Body",
365                    "Bath And Body"
366                  ]
367                },
368                "name": "Scented Moisturizing Body Lotion • Cherry Blossom",
369                "slug_key": "sephora-collection-scented-moisturizing-body-lotion-v-cherry-blossom",
370                "webstore_product_url": null
371              },
372              "quantity": 1,
373              "store": {
374                "code": "S0LJ"
375              }
376            }
377          ],
378          "billing_address_json": {
379            "address": ", Opp. Akruti Soc.",
380            "address1": "test data",
381            "address2": "",
382            "address_category": "",
383            "address_type": "Home",
384            "area": "Sama-Savli Road",
385            "area_code": "390008",
386            "area_code_slug": "pincode",
387            "city": "Vadodara",
388            "contact_person": "test test",
389            "country": "India",
390            "country_code": "+91",
391            "country_iso_code": "IN",
392            "country_phone_code": "+91",
393            "created_at": "2024-04-03 22:26:41",
394            "delivery_address_id": 5787620,
395            "display_address": "390008\nIndia",
396            "email": "test@example.com",
397            "geo_location": {
398              "latitude": 22.3216309,
399              "longitude": 73.19248639999999
400            },
401            "id": "660d8a1f4cc1ca0eb22c5b48",
402            "landmark": " Bank",
403            "latitude": 22.3216309,
404            "longitude": 73.19248639999999,
405            "name": "Tara Contractor",
406            "phone": "1111111111",
407            "pincode": "390008",
408            "sector": "",
409            "state": "Gujarat",
410            "state_code": "",
411            "uid": 5787620,
412            "updated_at": "2024-04-03 22:26:41",
413            "user_id": "660d87ea523a1f658c238042",
414            "version": "1.0"
415          },
416          "delivery_address_json": {
417            "address": " Bank, Opp. Akruti Soc.",
418            "address1": " test data",
419            "address2": "",
420            "address_category": "",
421            "address_type": "Home",
422            "area": "Sama-Savli Road",
423            "area_code": "390008",
424            "area_code_slug": "pincode",
425            "city": "Vadodara",
426            "contact_person": "test test",
427            "country": "India",
428            "country_code": "+91",
429            "country_iso_code": "IN",
430            "country_phone_code": "+91",
431            "created_at": "2024-04-03 22:26:41",
432            "delivery_address_id": 5787620,
433            "display_address": " 390008\nIndia",
434            "email": "test@example.com",
435            "geo_location": {
436              "latitude": 22.3216309,
437              "longitude": 73.19248639999999
438            },
439            "id": "660d8a1f4cc1ca0eb22c5b48",
440            "landmark": "Behind Axis Bank",
441            "latitude": 22.3216309,
442            "longitude": 73.19248639999999,
443            "name": "Tara Contractor",
444            "phone": "1111111111",
445            "pincode": "390008",
446            "sector": "",
447            "state": "Gujarat",
448            "state_code": "",
449            "uid": 5787620,
450            "updated_at": "2024-04-03 22:26:41",
451            "user_id": 18916007,
452            "version": "1.0"
453          },
454          "id": "17121634018461033725"
455        }
456      ],
457      "status": "placed",
458      "user": {
459        "email": "test@example.com",
460        "external_customer_id": null,
461        "first_name": "test",
462        "gender": "female",
463        "id": 18916007,
464        "is_anonymous_user": false,
465        "last_name": "C",
466        "meta": {
467          "country_phone_code": "91"
468        },
469        "mobile": "1111111111",
470        "mongo_user_id": "660d87ea523a1f658c238042",
471        "user_oid": "660d87ea523a1f658c238042"
472      }
473    }
474  }
475}

Payment

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

Events
application/payment/complete/v1
# this event is triggered when payment is completed
application/payment/failed/v1
# this event is triggered when payment is failed
application/payment/pending/v1
# this event is triggered when payment is pending

application/payment/complete/v1

this event is triggered when payment is completed

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
payment_object_list
array of object
Required
Array of Properties
amount_in_paisa
string
Required
amount of payment in paisa
currency
string
Required
currency in which payment need to be done
created_on
string
Required
transaction creation date
modified_on
string
Required
transaction modified date
company_id
string
Required
unique id for the company
payment_gateway
string
Required
name of the payment gateway
current_status
string
Required
current status of the payment
id
string
Required
unique id of payment
payment_mode_identifier
string
Required
show the sub mode for payment
user_object
object
Required
this contain user details
all_status
array of string
Required
array of all the payment status
application_id
string
Required
sales channel unique id
collected_by
string|null
Required
Payment is collected by whom
refunded_by
string|null
Required
who will be doing the refund
payment_mode
string
Required
show the Mode of payment
aggregator_payment_object
object|null
Additional payment details provided by the payment aggregator, if any.
refund_object
object|null
Details of the refund, if any.
payment_id
string|null
unique id for the transaction
merchant_order_id
string
Required
order id of merchant
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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "amount of payment in paisa"
106              },
107              "currency": {
108                "type": "string",
109                "description": "currency in which payment need to be done"
110              },
111              "created_on": {
112                "type": "string",
113                "description": "transaction creation date"
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "transaction modified date"
118              },
119              "company_id": {
120                "type": "string",
121                "description": "unique id for the company"
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "name of the payment gateway"
126              },
127              "current_status": {
128                "type": "string",
129                "description": "current status of the payment"
130              },
131              "id": {
132                "type": "string",
133                "description": "unique id of payment"
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "show the sub mode for payment"
138              },
139              "user_object": {
140                "type": "object",
141                "description": "this contain user details"
142              },
143              "all_status": {
144                "type": "array",
145                "description": "array of all the payment status",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "sales channel unique id"
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom"
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "who will be doing the refund"
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "show the Mode of payment"
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "unique id for the transaction"
192              }
193            }
194          }
195        },
196        "merchant_order_id": {
197          "type": "string",
198          "description": "order id of merchant"
199        }
200      }
201    }
202  }
203}
Payload Example
1{
2  "application_id": "620f5e013ef6e213110158bf",
3  "company_id": 1526,
4  "contains": [
5    "merchant_order_id",
6    "payment_object_list"
7  ],
8  "event": {
9    "category": "application",
10    "created_timestamp": 1709117158378,
11    "id": "Q/Vnk1zSEm2xQf8ayByyQdJOIVzx1qmd9I4zxcJVj6M=",
12    "name": "payment",
13    "trace_id": [],
14    "type": "complete",
15    "version": "1"
16  },
17  "payload": {
18    "merchant_order_id": "FY65DF0EE60EE9FEE70A",
19    "payment_object_list": [
20      {
21        "aggregator_payment_object": {},
22        "all_status": [
23          "started",
24          "failed",
25          "pending",
26          "complete"
27        ],
28        "amount_in_paisa": "1100",
29        "application_id": "620f5e013ef6e213110158bf",
30        "collected_by": "fynd",
31        "company_id": "1526",
32        "created_on": "2024-02-28 10:45:58",
33        "currency": "INR",
34        "current_status": "complete",
35        "id": "FY65DF0EE60EE9FEE70A",
36        "modified_on": "2024-02-28 10:45:58",
37        "payment_gateway": "Fynd",
38        "payment_id": "FY65DF0EE60EE9FEE70A",
39        "payment_mode": "COD",
40        "payment_mode_identifier": "11",
41        "refund_object": null,
42        "refunded_by": "fynd",
43        "user_object": {
44          "email": "test@example.com",
45          "id": "61238cb677e64915c444b391",
46          "merchant_user_id": "61238cb677e64915c444b391",
47          "mobile_number": "1111111111"
48        }
49      }
50    ]
51  }
52}

application/payment/failed/v1

this event is triggered when payment is failed

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
payment_object_list
array of object
Required
List containing details of payment transactions.
Array of Properties
amount_in_paisa
string
Required
Amount of payment in paisa.
currency
string
Required
Currency in which payment needs to be done.
created_on
string
Required
Transaction creation date.
modified_on
string
Required
Transaction modified date.
company_id
string
Required
Unique ID for the company.
payment_gateway
string
Required
Name of the payment gateway.
current_status
string
Required
Current status of the payment.
id
string
Required
Unique ID of payment.
payment_mode_identifier
string
Required
Shows the sub-mode for payment.
user_object
object
Required
Contains user details.
all_status
array of string
Required
Array of all the payment statuses.
application_id
string
Required
Sales channel unique ID.
collected_by
string|null
Required
Payment is collected by whom.
refunded_by
string|null
Required
Who will be doing the refund.
payment_mode
string
Required
Shows the mode of payment.
aggregator_payment_object
object|null
Additional payment details provided by the payment aggregator, if any.
refund_object
object|null
Details of the refund, if any.
payment_id
string|null
Unique ID for the transaction.
merchant_order_id
string
Required
Order ID of the merchant.
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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "Amount of payment in paisa."
106              },
107              "currency": {
108                "type": "string",
109                "description": "Currency in which payment needs to be done."
110              },
111              "created_on": {
112                "type": "string",
113                "description": "Transaction creation date."
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "Transaction modified date."
118              },
119              "company_id": {
120                "type": "string",
121                "description": "Unique ID for the company."
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "Name of the payment gateway."
126              },
127              "current_status": {
128                "type": "string",
129                "description": "Current status of the payment."
130              },
131              "id": {
132                "type": "string",
133                "description": "Unique ID of payment."
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "Shows the sub-mode for payment."
138              },
139              "user_object": {
140                "type": "object",
141                "description": "Contains user details."
142              },
143              "all_status": {
144                "type": "array",
145                "description": "Array of all the payment statuses.",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "Sales channel unique ID."
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom."
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "Who will be doing the refund."
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "Shows the mode of payment."
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "Unique ID for the transaction."
192              }
193            }
194          },
195          "description": "List containing details of payment transactions."
196        },
197        "merchant_order_id": {
198          "type": "string",
199          "description": "Order ID of the merchant."
200        }
201      }
202    }
203  }
204}
Payload Example
1{
2  "event": {
3    "trace_id": [],
4    "name": "payment",
5    "type": "failed",
6    "version": "1",
7    "created_timestamp": 1712150949157,
8    "id": "4da4gOa1sRYXfdZVH/UP49BV1MF0C1ImQ2P0NQIyOZY=",
9    "category": "application"
10  },
11  "company_id": 1103,
12  "application_id": "6331e737cf60c4c03a2cf965",
13  "contains": [
14    "merchant_order_id",
15    "payment_object_list"
16  ],
17  "payload": {
18    "merchant_order_id": "FY660D598B0E603C9107",
19    "payment_object_list": [
20      {
21        "currency": "INR",
22        "amount_in_paisa": "399900",
23        "modified_on": "2024-04-03 13:28:46",
24        "all_status": [
25          "started",
26          "failed",
27          "pending",
28          "complete"
29        ],
30        "id": "FY660D598B0E603C9107",
31        "payment_mode": "UPI",
32        "created_on": "2024-04-03 13:28:43",
33        "refund_object": null,
34        "collected_by": "fynd",
35        "payment_gateway": "Razorpay",
36        "aggregator_payment_object": {
37          "id": "pay_NuAMOIekDBT6rN",
38          "fee": null,
39          "tax": null,
40          "upi": {
41            "vpa": "test-2@ybl"
42          },
43          "vpa": "test-2@ybl",
44          "bank": null,
45          "email": "test@example.com",
46          "notes": [],
47          "amount": 399900,
48          "entity": "payment",
49          "method": "upi",
50          "status": "failed",
51          "wallet": null,
52          "card_id": null,
53          "contact": "1111111111",
54          "captured": false,
55          "currency": "INR",
56          "order_id": "order_NuAMNLfeIjSE2z",
57          "created_at": 1712150924,
58          "error_code": "BAD_REQUEST_ERROR",
59          "error_step": "payment_authentication",
60          "invoice_id": null,
61          "customer_id": "cust_MPthNaAwztxUCQ",
62          "description": null,
63          "error_reason": "payment_cancelled",
64          "error_source": "customer",
65          "acquirer_data": {
66            "rrn": null
67          },
68          "international": false,
69          "refund_status": null,
70          "amount_refunded": 0,
71          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
72        },
73        "application_id": "6331e737cf60c4c03a2cf965",
74        "refunded_by": "fynd",
75        "company_id": "1103",
76        "payment_id": "pay_NuAMOIekDBT6rN",
77        "user_object": {
78          "id": "64d9f1e82e1e95389f116ff3",
79          "email": "test@example.com",
80          "mobile_number": "1111111111",
81          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
82        },
83        "payment_mode_identifier": "test-2@ybl",
84        "current_status": "started"
85      },
86      {
87        "currency": "INR",
88        "amount_in_paisa": "399900",
89        "modified_on": "2024-04-03 13:28:46",
90        "all_status": [
91          "started",
92          "failed",
93          "pending",
94          "complete"
95        ],
96        "id": "FY660D598B0E603C9107",
97        "payment_mode": "UPI",
98        "created_on": "2024-04-03 13:28:43",
99        "refund_object": null,
100        "collected_by": "fynd",
101        "payment_gateway": "Razorpay",
102        "aggregator_payment_object": {
103          "id": "pay_NuAMOIekDBT6rN",
104          "fee": null,
105          "tax": null,
106          "upi": {
107            "vpa": "test-2@ybl"
108          },
109          "vpa": "test-2@ybl",
110          "bank": null,
111          "email": "test@example.com",
112          "notes": [],
113          "amount": 399900,
114          "entity": "payment",
115          "method": "upi",
116          "status": "failed",
117          "wallet": null,
118          "card_id": null,
119          "contact": "1111111111",
120          "captured": false,
121          "currency": "INR",
122          "order_id": "order_NuAMNLfeIjSE2z",
123          "created_at": 1712150924,
124          "error_code": "BAD_REQUEST_ERROR",
125          "error_step": "payment_authentication",
126          "invoice_id": null,
127          "customer_id": "cust_MPthNaAwztxUCQ",
128          "description": null,
129          "error_reason": "payment_cancelled",
130          "error_source": "customer",
131          "acquirer_data": {
132            "rrn": null
133          },
134          "international": false,
135          "refund_status": null,
136          "amount_refunded": 0,
137          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
138        },
139        "application_id": "6331e737cf60c4c03a2cf965",
140        "refunded_by": "fynd",
141        "company_id": "1103",
142        "payment_id": "pay_NuAMOIekDBT6rN",
143        "user_object": {
144          "id": "64d9f1e82e1e95389f116ff3",
145          "email": "test@example.com",
146          "mobile_number": "1111111111",
147          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
148        },
149        "payment_mode_identifier": "test-2@ybl",
150        "current_status": "failed"
151      },
152      {
153        "currency": "INR",
154        "amount_in_paisa": "399900",
155        "modified_on": "2024-04-03 13:28:46",
156        "all_status": [
157          "started",
158          "failed",
159          "pending",
160          "complete"
161        ],
162        "id": "FY660D598B0E603C9107",
163        "payment_mode": "UPI",
164        "created_on": "2024-04-03 13:28:43",
165        "refund_object": null,
166        "collected_by": "fynd",
167        "payment_gateway": "Razorpay",
168        "aggregator_payment_object": {
169          "id": "pay_NuAMOIekDBT6rN",
170          "fee": null,
171          "tax": null,
172          "upi": {
173            "vpa": "test-2@ybl"
174          },
175          "vpa": "test-2@ybl",
176          "bank": null,
177          "email": "test@example.com",
178          "notes": [],
179          "amount": 399900,
180          "entity": "payment",
181          "method": "upi",
182          "status": "failed",
183          "wallet": null,
184          "card_id": null,
185          "contact": "1111111111",
186          "captured": false,
187          "currency": "INR",
188          "order_id": "order_NuAMNLfeIjSE2z",
189          "created_at": 1712150924,
190          "error_code": "BAD_REQUEST_ERROR",
191          "error_step": "payment_authentication",
192          "invoice_id": null,
193          "customer_id": "cust_MPthNaAwztxUCQ",
194          "description": null,
195          "error_reason": "payment_cancelled",
196          "error_source": "customer",
197          "acquirer_data": {
198            "rrn": null
199          },
200          "international": false,
201          "refund_status": null,
202          "amount_refunded": 0,
203          "error_description": "You may have cancelled the payment or there was a delay in response from the UPI app."
204        },
205        "application_id": "6331e737cf60c4c03a2cf965",
206        "refunded_by": "fynd",
207        "company_id": "1103",
208        "payment_id": "pay_NuAMOIekDBT6rN",
209        "user_object": {
210          "id": "64d9f1e82e1e95389f116ff3",
211          "email": "test@example.com",
212          "mobile_number": "1111111111",
213          "merchant_user_id": "64d9f1e82e1e95389f116ff3"
214        },
215        "payment_mode_identifier": "test-2@ybl",
216        "current_status": "failed"
217      }
218    ]
219  }
220}

application/payment/pending/v1

this event is triggered when payment is pending

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
Payload containing a list of payment objects related to a merchant's order.
Properties
payment_object_list
array of object
Required
List containing details of payment transactions.
Array of Properties
amount_in_paisa
string
Required
Amount of payment in paisa.
currency
string
Required
Currency in which payment needs to be done.
created_on
string
Required
Transaction creation date.
modified_on
string
Required
Transaction modified date.
company_id
string
Required
Unique ID for the company.
payment_gateway
string
Required
Name of the payment gateway.
current_status
string
Required
Current status of the payment.
id
string
Required
Unique ID of the payment.
payment_mode_identifier
string
Required
Shows the sub-mode for payment.
user_object
object
Required
Contains user details.
all_status
array of string
Required
Array of all the payment statuses.
application_id
string
Required
Sales channel unique ID.
collected_by
string|null
Required
Payment is collected by whom.
refunded_by
string|null
Required
Who will be doing the refund.
payment_mode
string
Required
Shows the mode of payment.
aggregator_payment_object
object|null
Additional payment details provided by the payment aggregator, if any.
refund_object
object|null
Details of the refund, if any.
payment_id
string|null
Unique ID for the transaction.
merchant_order_id
string
Required
Order ID for the merchant.
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        "payment_object_list",
78        "merchant_order_id"
79      ],
80      "properties": {
81        "payment_object_list": {
82          "type": "array",
83          "items": {
84            "type": "object",
85            "required": [
86              "amount_in_paisa",
87              "currency",
88              "created_on",
89              "modified_on",
90              "company_id",
91              "payment_gateway",
92              "current_status",
93              "id",
94              "payment_mode_identifier",
95              "user_object",
96              "all_status",
97              "application_id",
98              "collected_by",
99              "payment_mode",
100              "refunded_by"
101            ],
102            "properties": {
103              "amount_in_paisa": {
104                "type": "string",
105                "description": "Amount of payment in paisa."
106              },
107              "currency": {
108                "type": "string",
109                "description": "Currency in which payment needs to be done."
110              },
111              "created_on": {
112                "type": "string",
113                "description": "Transaction creation date."
114              },
115              "modified_on": {
116                "type": "string",
117                "description": "Transaction modified date."
118              },
119              "company_id": {
120                "type": "string",
121                "description": "Unique ID for the company."
122              },
123              "payment_gateway": {
124                "type": "string",
125                "description": "Name of the payment gateway."
126              },
127              "current_status": {
128                "type": "string",
129                "description": "Current status of the payment."
130              },
131              "id": {
132                "type": "string",
133                "description": "Unique ID of the payment."
134              },
135              "payment_mode_identifier": {
136                "type": "string",
137                "description": "Shows the sub-mode for payment."
138              },
139              "user_object": {
140                "type": "object",
141                "description": "Contains user details."
142              },
143              "all_status": {
144                "type": "array",
145                "description": "Array of all the payment statuses.",
146                "items": {
147                  "type": "string"
148                }
149              },
150              "application_id": {
151                "type": "string",
152                "description": "Sales channel unique ID."
153              },
154              "collected_by": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "Payment is collected by whom."
160              },
161              "refunded_by": {
162                "type": [
163                  "string",
164                  "null"
165                ],
166                "description": "Who will be doing the refund."
167              },
168              "payment_mode": {
169                "type": "string",
170                "description": "Shows the mode of payment."
171              },
172              "aggregator_payment_object": {
173                "type": [
174                  "object",
175                  "null"
176                ],
177                "description": "Additional payment details provided by the payment aggregator, if any."
178              },
179              "refund_object": {
180                "type": [
181                  "object",
182                  "null"
183                ],
184                "description": "Details of the refund, if any."
185              },
186              "payment_id": {
187                "type": [
188                  "string",
189                  "null"
190                ],
191                "description": "Unique ID for the transaction."
192              }
193            }
194          },
195          "description": "List containing details of payment transactions."
196        },
197        "merchant_order_id": {
198          "type": "string",
199          "description": "Order ID for the merchant."
200        }
201      },
202      "description": "Payload containing a list of payment objects related to a merchant's order."
203    }
204  }
205}
Payload Example
1{
2  "payload": {
3    "payment_object_list": [
4      {
5        "modified_on": "2024-04-04 11:13:25",
6        "all_status": [
7          "started",
8          "failed",
9          "pending",
10          "complete"
11        ],
12        "company_id": "568",
13        "current_status": "started",
14        "payment_mode": "QR",
15        "payment_mode_identifier": "QR",
16        "payment_gateway": "Razorpay",
17        "id": "FY660E8B400EECA4CC5A",
18        "collected_by": "fynd",
19        "payment_id": "pay_NuWaYR6G8joPZk",
20        "amount_in_paisa": "4400000",
21        "created_on": "2024-04-04 11:13:04",
22        "aggregator_payment_object": {
23          "id": "pay_NuWaYR6G8joPZk",
24          "fee": null,
25          "tax": null,
26          "upi": {
27            "vpa": "test@okicici",
28            "payer_account_type": "bank_account"
29          },
30          "vpa": "test@okicici",
31          "bank": null,
32          "email": "test@example.com",
33          "notes": {
34            "order_id": "order_NuWaCABtaEizkF",
35            "merchant_order_id": "FY660E8B400EECA4CC5A"
36          },
37          "amount": 4400000,
38          "entity": "payment",
39          "method": "upi",
40          "reward": null,
41          "status": "authorized",
42          "wallet": null,
43          "card_id": null,
44          "contact": "1111111111",
45          "captured": false,
46          "currency": "INR",
47          "order_id": null,
48          "created_at": 1712229204,
49          "error_code": null,
50          "error_step": null,
51          "invoice_id": null,
52          "customer_id": "cust_NLh3fYAuwW4jMB",
53          "description": "QRv2 Payment",
54          "error_reason": null,
55          "error_source": null,
56          "acquirer_data": {
57            "rrn": "409560562817"
58          },
59          "international": false,
60          "refund_status": null,
61          "amount_refunded": 0,
62          "error_description": null
63        },
64        "application_id": "5da1aa89e9b4036afd623686",
65        "refund_object": null,
66        "user_object": {
67          "id": "23542890",
68          "email": "test@example.com",
69          "mobile_number": "1111111111",
70          "merchant_user_id": "659a7ab6e0a98803e7153799"
71        },
72        "refunded_by": "fynd",
73        "currency": "INR"
74      },
75      {
76        "modified_on": "2024-04-04 11:13:25",
77        "all_status": [
78          "started",
79          "failed",
80          "pending",
81          "complete"
82        ],
83        "company_id": "568",
84        "current_status": "pending",
85        "payment_mode": "QR",
86        "payment_mode_identifier": "QR",
87        "payment_gateway": "Razorpay",
88        "id": "FY660E8B400EECA4CC5A",
89        "collected_by": "fynd",
90        "payment_id": "pay_NuWaYR6G8joPZk",
91        "amount_in_paisa": "4400000",
92        "created_on": "2024-04-04 11:13:04",
93        "aggregator_payment_object": {
94          "id": "pay_NuWaYR6G8joPZk",
95          "fee": null,
96          "tax": null,
97          "upi": {
98            "vpa": "test@okicici",
99            "payer_account_type": "bank_account"
100          },
101          "vpa": "test@okicici",
102          "bank": null,
103          "email": "test@example.com",
104          "notes": {
105            "order_id": "order_NuWaCABtaEizkF",
106            "merchant_order_id": "FY660E8B400EECA4CC5A"
107          },
108          "amount": 4400000,
109          "entity": "payment",
110          "method": "upi",
111          "reward": null,
112          "status": "authorized",
113          "wallet": null,
114          "card_id": null,
115          "contact": "1111111111",
116          "captured": false,
117          "currency": "INR",
118          "order_id": null,
119          "created_at": 1712229204,
120          "error_code": null,
121          "error_step": null,
122          "invoice_id": null,
123          "customer_id": "cust_NLh3fYAuwW4jMB",
124          "description": "QRv2 Payment",
125          "error_reason": null,
126          "error_source": null,
127          "acquirer_data": {
128            "rrn": "409560562817"
129          },
130          "international": false,
131          "refund_status": null,
132          "amount_refunded": 0,
133          "error_description": null
134        },
135        "application_id": "5da1aa89e9b4036afd623686",
136        "refund_object": null,
137        "user_object": {
138          "id": "23542890",
139          "email": "test@example.com",
140          "mobile_number": "1111111111",
141          "merchant_user_id": "659a7ab6e0a98803e7153799"
142        },
143        "refunded_by": "fynd",
144        "currency": "INR"
145      }
146    ],
147    "merchant_order_id": "FY660E8B400EECA4CC5A"
148  },
149  "contains": [
150    "payment_object_list"
151  ],
152  "event": {
153    "id": "testID",
154    "name": "payment",
155    "type": "pending",
156    "version": "1",
157    "trace_id": [
158      "gringotts.5b3e1ce8-f274-11ee-bfb0-c60d174d5d1b"
159    ],
160    "created_timestamp": 1712229205598,
161    "category": "application"
162  },
163  "company_id": 568,
164  "application_id": "5da1aa89e9b4036afd623686"
165}

Product

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

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

application/product/create/v1

this event is triggered when product 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
product
array of object
Required
Array of Properties
_id
string
The unique identifier for the product.
product_online_date
string
Required
The date on which the product will be live on platform
no_of_boxes
integer
Required
Number of boxes containing the product.
platforms
object
The platforms where the product is available.
Properties
fynd
boolean
Indicates whether the product is available on the Fynd platform.
uniket_wholesale
boolean
Indicates whether the product is available on the Uniket Wholesale platform.
ondc
boolean
Indicates whether the product is available on the ONDC platform.
media
array of object
List of media information associated with the product.
Array of Properties
url
string
URL of the media file
type
string
Type of the media file
alt
string
Media information for the product
meta
object
Media information for the product media
item_code
string
Required
Item code for the product.
is_promotional
boolean
Flag indicating if the product is promotional.
description
string
Description of the product.
videos
array of object
List of videos associated with the product
Array of Properties
thumbnail
string
URL of the video thumbnail image
type
string
Type of video platform (e.g., YouTube)
url
string
URL of the embedded video
modified_on
string
The date and time when the product was last modified
teaser_tag
object
Teaser tag for the product.
Properties
tag
string
Tag for teaser of the product.
discount
number
Discount applied to the product.
short_description
string
A short description of the product, limited to 50 characters.
created_on
string
The date and time when the product was created
images
array of string
Images associated with the product.
popularity
integer
Popularity score of the product.
sizes
array of string
Required
The sizes data of the product.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
meta
object
Metadata associated with the product.
Properties
service
string
Service metadata associated with the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
net_quantity
string
A nested object representing the net quantity of the product.
uid
integer
Required
The unique identifier of the product.
raw
object
Raw data associated with the product.
size_guide
string
URL to the size guide for the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
template_tag
string
Required
The tag used for the product template.
attributes
object
Attributes of the product.
departments
array of integer
Required
List of department IDs associated with the product.
all_sizes
array of string
Required
All available sizes for the product.
highlights
array of string
A list of highlights or special features associated with the product.
item_type
string
Required
Type of the product.
slug
string
Required
Unique slug for the product.
all_company_ids
array of integer
Required
All company IDs associated with the product.
image_nature
string
Required
The nature of the product's images.
tags
array of string
List of tags associated with the product.
price
object
Required
Price of the item
Properties
effective
object
Required
The effective price of the product.
Properties
min
number
Required
The minimum effective price of the product.
max
number
Required
The maximum effective price of the product.
marked
object
Required
The marked price of the product.
Properties
min
number
Required
The minimum marked price of the product.
max
number
Required
The maximum marked price of the product.
currency
string
Required
The currency in which the prices are denoted.
selling
object
The selling price of the product.
Properties
min
number
Required
The minimum selling price of the product.
max
number
Required
The maximum selling price of the product.
store_ids
array of integer
IDs of the stores where the product is available.
multi_categories
array of object
Flag indicating if the product belongs to multiple categories.
Array of Properties
l3
integer
ID of the third-level category.
is_active
boolean
Indicates whether the item is active or not.
department
integer
ID of the department to which the item belongs.
l2
integer
ID of the second-level category.
l1
integer
ID of the first-level category.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
product_group_tag
array of string
Tag associated with the product group.
created_by
object
User who created the product.
Properties
username
string
Required
Username of the user who created the company
user_id
string
Required
User ID of the user who created the company
super_user
boolean
Flag indicating if the creator is a super user.
variant_media
object
A dictionary of media files associated with each variant of the product.
l3_category_names
array of string
Names of L3 categories associated with the product.
quantity
integer
Required
Quantity of the product.
country_of_origin
string
Required
Country of origin for the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
custom_order
object
Custom order information for the product.
Properties
is_custom_order
boolean
Flag indicating if the product is a custom order or not.
manufacturing_time_unit
string
The unit of time used to measure the time required to manufacture the product.
manufacturing_time
integer
The time required to manufacture the product, in the specified time unit.
_custom_json
object
A dictionary of custom JSON data associated with the product.
name
string
Required
Name of the product.
l3_categories
array of integer
Required
L3 categories associated with the product.
all_identifiers
array of string
Required
All identifiers associated with the product.
modified_by
object
User who last modified the product.
Properties
username
string
Required
Username of the user who last modified the company
user_id
string
Required
User ID of the user who last modified the company
super_user
boolean
Flag indicating if the user is a super user.
verification_status
string
The verification status of the product.
all_store_ids
array of integer
List of IDs of all stores.
company_ids
array of integer
List of IDs of companies.
expiration_date
string
Required
Date when product expires.
identifier
object
Contains Product identifiers types with their values.
out_of_stock
boolean
Flag indicating if product is out of stock.
store_id_list
array of string
Required
List of store ids in the which the products has inventory
sellable_quantity
integer
Required
Quantity of product that is sellable.
company_id_list
array of string
Required
List of company ids in the which the products has inventory
article_identifiers
array of string
Identifiers for articles.
sizes_with_price
array of object
Sizes along with their prices.
Array of Properties
size
string
identifiers
array of object
Array of Properties
gtin_type
string
Required
gtin_value
string
Required
quantity
integer
is_available
boolean
Required
Product availability status on the basis of inventory configuration
zone_identifier
string
Identifier for a zone.
channel_identifier
string
Required
Identifier for a channel.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
category_slug
string
Required
Slug of the category associated with the product.
moq
object
Minimum Order Quantity (MOQ) refers to the smallest amount of a product that a supplier is willing to sell.
Properties
minimum
integer
The minimum quantity that can be ordered as part of the Minimum Order Quantity.
increment_unit
integer
The unit by which the Minimum Order Quantity can be increased.
seo
object
Search Engine Optimization (SEO) refers to the process of improving the visibility of a website or a web page in search engine results.
Properties
title
string
The title tag of a web page is an HTML element that specifies the title of the page. It is displayed on search engine results pages as the clickable headline for a given result.
description
string
The meta description tag of a web page is an HTML element that summarizes the content of the page. It is often displayed underneath the title tag on search engine results pages.
_custom_meta
array of object
Custom meta associated with the product
Array of Properties
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
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      "properties": {
77        "product": {
78          "type": "array",
79          "items": {
80            "type": "object",
81            "properties": {
82              "_id": {
83                "type": "string",
84                "description": "The unique identifier for the product."
85              },
86              "product_online_date": {
87                "type": "string",
88                "description": "The date on which the product will be live on platform"
89              },
90              "no_of_boxes": {
91                "type": "integer",
92                "description": "Number of boxes containing the product."
93              },
94              "platforms": {
95                "type": "object",
96                "description": "The platforms where the product is available.",
97                "properties": {
98                  "fynd": {
99                    "type": "boolean",
100                    "description": "Indicates whether the product is available on the Fynd platform."
101                  },
102                  "uniket_wholesale": {
103                    "type": "boolean",
104                    "description": "Indicates whether the product is available on the Uniket Wholesale platform."
105                  },
106                  "ondc": {
107                    "type": "boolean",
108                    "description": "Indicates whether the product is available on the ONDC platform."
109                  }
110                }
111              },
112              "media": {
113                "type": "array",
114                "items": {
115                  "type": "object",
116                  "properties": {
117                    "url": {
118                      "type": "string",
119                      "description": "URL of the media file"
120                    },
121                    "type": {
122                      "type": "string",
123                      "description": "Type of the media file"
124                    },
125                    "alt": {
126                      "type": "string",
127                      "description": "Media information for the product"
128                    },
129                    "meta": {
130                      "type": "object",
131                      "description": "Media information for the product media",
132                      "additionalProperties": true
133                    }
134                  }
135                },
136                "description": "List of media information associated with the product."
137              },
138              "item_code": {
139                "type": "string",
140                "description": "Item code for the product."
141              },
142              "is_promotional": {
143                "type": "boolean",
144                "description": "Flag indicating if the product is promotional."
145              },
146              "description": {
147                "type": "string",
148                "description": "Description of the product."
149              },
150              "videos": {
151                "description": "List of videos associated with the product",
152                "type": "array",
153                "items": {
154                  "type": "object",
155                  "properties": {
156                    "thumbnail": {
157                      "description": "URL of the video thumbnail image",
158                      "type": "string"
159                    },
160                    "type": {
161                      "description": "Type of video platform (e.g., YouTube)",
162                      "type": "string"
163                    },
164                    "url": {
165                      "description": "URL of the embedded video",
166                      "type": "string"
167                    }
168                  }
169                }
170              },
171              "modified_on": {
172                "type": "string",
173                "description": "The date and time when the product was last modified"
174              },
175              "teaser_tag": {
176                "type": "object",
177                "properties": {
178                  "tag": {
179                    "type": "string",
180                    "description": "Tag for teaser of the product."
181                  }
182                },
183                "description": "Teaser tag for the product."
184              },
185              "discount": {
186                "type": "number",
187                "description": "Discount applied to the product."
188              },
189              "short_description": {
190                "type": "string",
191                "description": "A short description of the product, limited to 50 characters."
192              },
193              "created_on": {
194                "type": "string",
195                "description": "The date and time when the product was created"
196              },
197              "images": {
198                "type": "array",
199                "items": {
200                  "type": "string"
201                },
202                "description": "Images associated with the product."
203              },
204              "popularity": {
205                "type": "integer",
206                "description": "Popularity score of the product."
207              },
208              "sizes": {
209                "type": "array",
210                "items": {
211                  "type": "string"
212                },
213                "description": "The sizes data of the product."
214              },
215              "is_set": {
216                "type": "boolean",
217                "description": "Flag to indicate if the product is a set or not."
218              },
219              "meta": {
220                "type": "object",
221                "properties": {
222                  "service": {
223                    "type": "string",
224                    "description": "Service metadata associated with the product."
225                  }
226                },
227                "description": "Metadata associated with the product."
228              },
229              "multi_size": {
230                "type": "boolean",
231                "description": "Flag to indicate if the product has multiple sizes or not."
232              },
233              "net_quantity": {
234                "type": "string",
235                "description": "A nested object representing the net quantity of the product."
236              },
237              "uid": {
238                "type": "integer",
239                "description": "The unique identifier of the product."
240              },
241              "raw": {
242                "type": "object",
243                "description": "Raw data associated with the product."
244              },
245              "size_guide": {
246                "type": "string",
247                "description": "URL to the size guide for the product."
248              },
249              "brand_uid": {
250                "type": "integer",
251                "description": "Unique ID of the brand associated with the product."
252              },
253              "template_tag": {
254                "type": "string",
255                "description": "The tag used for the product template."
256              },
257              "attributes": {
258                "type": "object",
259                "description": "Attributes of the product."
260              },
261              "departments": {
262                "type": "array",
263                "items": {
264                  "type": "integer"
265                },
266                "description": "List of department IDs associated with the product."
267              },
268              "all_sizes": {
269                "type": "array",
270                "items": {
271                  "type": "string"
272                },
273                "description": "All available sizes for the product."
274              },
275              "highlights": {
276                "type": "array",
277                "items": {
278                  "type": "string"
279                },
280                "description": "A list of highlights or special features associated with the product."
281              },
282              "item_type": {
283                "type": "string",
284                "description": "Type of the product."
285              },
286              "slug": {
287                "type": "string",
288                "description": "Unique slug for the product."
289              },
290              "all_company_ids": {
291                "type": "array",
292                "items": {
293                  "type": "integer"
294                },
295                "description": "All company IDs associated with the product."
296              },
297              "image_nature": {
298                "type": "string",
299                "description": "The nature of the product's images."
300              },
301              "tags": {
302                "type": "array",
303                "items": {
304                  "type": "string"
305                },
306                "description": "List of tags associated with the product."
307              },
308              "price": {
309                "type": "object",
310                "properties": {
311                  "effective": {
312                    "type": "object",
313                    "properties": {
314                      "min": {
315                        "type": "number",
316                        "description": "The minimum effective price of the product."
317                      },
318                      "max": {
319                        "type": "number",
320                        "description": "The maximum effective price of the product."
321                      }
322                    },
323                    "required": [
324                      "min",
325                      "max"
326                    ],
327                    "description": "The effective price of the product."
328                  },
329                  "marked": {
330                    "type": "object",
331                    "properties": {
332                      "min": {
333                        "type": "number",
334                        "description": "The minimum marked price of the product."
335                      },
336                      "max": {
337                        "type": "number",
338                        "description": "The maximum marked price of the product."
339                      }
340                    },
341                    "required": [
342                      "min",
343                      "max"
344                    ],
345                    "description": "The marked price of the product."
346                  },
347                  "currency": {
348                    "type": "string",
349                    "description": "The currency in which the prices are denoted."
350                  },
351                  "selling": {
352                    "type": "object",
353                    "properties": {
354                      "min": {
355                        "type": "number",
356                        "description": "The minimum selling price of the product."
357                      },
358                      "max": {
359                        "type": "number",
360                        "description": "The maximum selling price of the product."
361                      }
362                    },
363                    "required": [
364                      "min",
365                      "max"
366                    ],
367                    "description": "The selling price of the product."
368                  }
369                },
370                "required": [
371                  "effective",
372                  "marked",
373                  "currency"
374                ],
375                "description": "Price of the item"
376              },
377              "store_ids": {
378                "type": "array",
379                "items": {
380                  "type": "integer"
381                },
382                "description": "IDs of the stores where the product is available."
383              },
384              "multi_categories": {
385                "type": "array",
386                "items": {
387                  "type": "object",
388                  "properties": {
389                    "l3": {
390                      "type": "integer",
391                      "description": "ID of the third-level category."
392                    },
393                    "is_active": {
394                      "type": "boolean",
395                      "description": "Indicates whether the item is active or not."
396                    },
397                    "department": {
398                      "type": "integer",
399                      "description": "ID of the department to which the item belongs."
400                    },
401                    "l2": {
402                      "type": "integer",
403                      "description": "ID of the second-level category."
404                    },
405                    "l1": {
406                      "type": "integer",
407                      "description": "ID of the first-level category."
408                    }
409                  }
410                },
411                "description": "Flag indicating if the product belongs to multiple categories."
412              },
413              "is_dependent": {
414                "type": "boolean",
415                "description": "Flag to indicate if the product is dependent on other products or not."
416              },
417              "product_group_tag": {
418                "type": "array",
419                "items": {
420                  "type": "string"
421                },
422                "description": "Tag associated with the product group."
423              },
424              "created_by": {
425                "type": "object",
426                "properties": {
427                  "username": {
428                    "type": "string",
429                    "description": "Username of the user who created the company"
430                  },
431                  "user_id": {
432                    "type": "string",
433                    "description": "User ID of the user who created the company"
434                  },
435                  "super_user": {
436                    "type": "boolean",
437                    "description": "Flag indicating if the creator is a super user."
438                  }
439                },
440                "required": [
441                  "username",
442                  "user_id"
443                ],
444                "description": "User who created the product."
445              },
446              "variant_media": {
447                "type": "object",
448                "description": "A dictionary of media files associated with each variant of the product."
449              },
450              "l3_category_names": {
451                "type": "array",
452                "items": {
453                  "type": "string"
454                },
455                "description": "Names of L3 categories associated with the product."
456              },
457              "quantity": {
458                "type": "integer",
459                "description": "Quantity of the product."
460              },
461              "country_of_origin": {
462                "type": "string",
463                "description": "Country of origin for the product."
464              },
465              "variants": {
466                "type": "object",
467                "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
468              },
469              "custom_order": {
470                "type": "object",
471                "properties": {
472                  "is_custom_order": {
473                    "type": "boolean",
474                    "description": "Flag indicating if the product is a custom order or not."
475                  },
476                  "manufacturing_time_unit": {
477                    "type": "string",
478                    "description": "The unit of time used to measure the time required to manufacture the product."
479                  },
480                  "manufacturing_time": {
481                    "type": "integer",
482                    "description": "The time required to manufacture the product, in the specified time unit."
483                  }
484                },
485                "description": "Custom order information for the product."
486              },
487              "_custom_json": {
488                "type": "object",
489                "description": "A dictionary of custom JSON data associated with the product."
490              },
491              "name": {
492                "type": "string",
493                "description": "Name of the product."
494              },
495              "l3_categories": {
496                "type": "array",
497                "items": {
498                  "type": "integer"
499                },
500                "description": "L3 categories associated with the product."
501              },
502              "all_identifiers": {
503                "type": "array",
504                "items": {
505                  "type": "string"
506                },
507                "description": "All identifiers associated with the product."
508              },
509              "modified_by": {
510                "type": "object",
511                "properties": {
512                  "username": {
513                    "type": "string",
514                    "description": "Username of the user who last modified the company"
515                  },
516                  "user_id": {
517                    "type": "string",
518                    "description": "User ID of the user who last modified the company"
519                  },
520                  "super_user": {
521                    "type": "boolean",
522                    "description": "Flag indicating if the user is a super user."
523                  }
524                },
525                "required": [
526                  "username",
527                  "user_id"
528                ],
529                "description": "User who last modified the product."
530              },
531              "verification_status": {
532                "type": "string",
533                "description": "The verification status of the product."
534              },
535              "all_store_ids": {
536                "type": "array",
537                "items": {
538                  "type": "integer"
539                },
540                "description": "List of IDs of all stores."
541              },
542              "company_ids": {
543                "type": "array",
544                "items": {
545                  "type": "integer"
546                },
547                "description": "List of IDs of companies."
548              },
549              "expiration_date": {
550                "type": "string",
551                "description": "Date when product expires."
552              },
553              "identifier": {
554                "type": "object",
555                "additionalProperties": true,
556                "description": "Contains Product identifiers types with their values.",
557                "example": {
558                  "ean": [
559                    "8011003804542"
560                  ],
561                  "alu": [
562                    "000000000490936300",
563                    "0000000006167126612",
564                    "0000000001872378232"
565                  ],
566                  "sku": [
567                    "SKU12345",
568                    "SKU67890"
569                  ]
570                }
571              },
572              "out_of_stock": {
573                "type": "boolean",
574                "description": "Flag indicating if product is out of stock."
575              },
576              "store_id_list": {
577                "type": "array",
578                "items": {
579                  "type": "string"
580                },
581                "description": "List of store ids in the which the products has inventory"
582              },
583              "sellable_quantity": {
584                "type": "integer",
585                "description": "Quantity of product that is sellable."
586              },
587              "company_id_list": {
588                "type": "array",
589                "items": {
590                  "type": "string"
591                },
592                "description": "List of company ids in the which the products has inventory"
593              },
594              "article_identifiers": {
595                "type": "array",
596                "items": {
597                  "type": "string"
598                },
599                "description": "Identifiers for articles."
600              },
601              "sizes_with_price": {
602                "type": "array",
603                "items": {
604                  "type": "object",
605                  "properties": {
606                    "size": {
607                      "type": "string"
608                    },
609                    "identifiers": {
610                      "type": "array",
611                      "items": {
612                        "type": "object",
613                        "properties": {
614                          "gtin_type": {
615                            "type": "string"
616                          },
617                          "gtin_value": {
618                            "type": "string"
619                          }
620                        },
621                        "required": [
622                          "gtin_type",
623                          "gtin_value"
624                        ]
625                      }
626                    },
627                    "quantity": {
628                      "type": "integer"
629                    }
630                  }
631                },
632                "description": "Sizes along with their prices."
633              },
634              "is_available": {
635                "type": "boolean",
636                "description": "Product availability status on the basis of inventory configuration"
637              },
638              "zone_identifier": {
639                "type": "string",
640                "description": "Identifier for a zone."
641              },
642              "channel_identifier": {
643                "type": "string",
644                "description": "Identifier for a channel."
645              },
646              "category_uid": {
647                "type": "integer",
648                "description": "The unique identifier of the category that the product belongs to."
649              },
650              "category_slug": {
651                "type": "string",
652                "description": "Slug of the category associated with the product."
653              },
654              "moq": {
655                "type": "object",
656                "properties": {
657                  "minimum": {
658                    "type": "integer",
659                    "description": "The minimum quantity that can be ordered as part of the Minimum Order Quantity."
660                  },
661                  "increment_unit": {
662                    "type": "integer",
663                    "description": "The unit by which the Minimum Order Quantity can be increased."
664                  }
665                },
666                "description": "Minimum Order Quantity (MOQ) refers to the smallest amount of a product that a supplier is willing to sell."
667              },
668              "seo": {
669                "type": "object",
670                "properties": {
671                  "title": {
672                    "type": "string",
673                    "description": "The title tag of a web page is an HTML element that specifies the title of the page. It is displayed on search engine results pages as the clickable headline for a given result."
674                  },
675                  "description": {
676                    "type": "string",
677                    "description": "The meta description tag of a web page is an HTML element that summarizes the content of the page. It is often displayed underneath the title tag on search engine results pages."
678                  }
679                },
680                "description": "Search Engine Optimization (SEO) refers to the process of improving the visibility of a website or a web page in search engine results."
681              },
682              "_custom_meta": {
683                "type": "array",
684                "items": {
685                  "type": "object",
686                  "properties": {
687                    "key": {
688                      "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",
689                      "maxLength": 30,
690                      "minLength": 1,
691                      "type": "string"
692                    },
693                    "value": {
694                      "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",
695                      "maxLength": 100,
696                      "minLength": 1,
697                      "type": "string"
698                    }
699                  }
700                },
701                "description": "Custom meta associated with the product"
702              }
703            },
704            "required": [
705              "product_online_date",
706              "no_of_boxes",
707              "item_code",
708              "sizes",
709              "is_set",
710              "multi_size",
711              "uid",
712              "brand_uid",
713              "template_tag",
714              "departments",
715              "all_sizes",
716              "item_type",
717              "slug",
718              "all_company_ids",
719              "image_nature",
720              "price",
721              "is_dependent",
722              "quantity",
723              "country_of_origin",
724              "name",
725              "l3_categories",
726              "all_identifiers",
727              "expiration_date",
728              "store_id_list",
729              "sellable_quantity",
730              "company_id_list",
731              "is_available",
732              "channel_identifier",
733              "category_uid",
734              "category_slug"
735            ]
736          }
737        }
738      },
739      "required": [
740        "product"
741      ]
742    }
743  }
744}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.d54c8c1a-edb8-11ee-8647-1a5e8a2fd34f"
5    ],
6    "name": "product",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711708860339,
10    "id": "2FsXLqLSv8nAeTfFgSEzIwWdvNfnZXp7Cq6BlZKBl/E=",
11    "category": "application"
12  },
13  "company_id": 3932,
14  "application_id": [
15    "6544ddbd1a0e93369133a063",
16    "*"
17  ],
18  "contains": [
19    "product"
20  ],
21  "payload": {
22    "product": [
23      {
24        "_id": "64b903b65166795edfe7758b",
25        "brand_uid": 414,
26        "description": "Light Green Floral Print Mini Waffle Polo T-Shirt In Cotton Stretch",
27        "created_by": {
28          "username": "test_example_com_12345",
29          "user_id": "dea3b006029fd6724a0e2798",
30          "super_user": false
31        },
32        "discount": 0,
33        "item_type": "standard",
34        "template_tag": "topwear",
35        "meta": {
36          "service": "Silverbolt"
37        },
38        "images": [
39          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/y_xY2Pb8ys-MFK-9579-R-147-LIGHT-GREEN-1.jpg",
40          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/mk8o-XK1Jx-MFK-9579-R-147-LIGHT-GREEN-2.jpg",
41          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/igZ__oe01F-MFK-9579-R-147-LIGHT-GREEN-3.jpg",
42          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/a4yCoa0FpT-MFK-9579-R-147-LIGHT-GREEN-4.jpg",
43          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/8K7WedADzq-MFK-9579-R-147-LIGHT-GREEN-5.jpg",
44          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/Qhidbc7rEQ-MFK-9579-R-147-LIGHT-GREEN-6.jpg",
45          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/Bm_m0AMJS-MFK-9579-R-147-LIGHT-GREEN-7.jpg"
46        ],
47        "attributes": {
48          "season": "AW-23",
49          "essential": "No",
50          "gender": [
51            "Men"
52          ],
53          "primary_color": "Green",
54          "primary_material": "Cotton Blend",
55          "care_instructions": "Machine Wash Inside Out, Gentle, Cold Water",
56          "color": "Light Green",
57          "material": "95% Cotton/5% Elastane",
58          "net-quantity": "1 N",
59          "age-group": "Adults",
60          "marketer-name": "Credo Brands Marketing Limited",
61          "marketer-address": "dummy data",
62          "name": "Light Green Floral Print Mini Waffle Polo T-Shirt",
63          "description": "Light Green Floral Print Mini Waffle Polo T-Shirt In Cotton Stretch",
64          "primary-colour-hex-code": "2BD892",
65          "product_details": "Light Green Floral Print Mini Waffle Polo T-Shirt In Cotton Stretch",
66          "short_description": "Light Green Floral Print Mini Waffle Polo T-Shirt",
67          "brand_name": "MUFTI",
68          "primary_color_hex": "2BD892"
69        },
70        "raw": {},
71        "country_of_origin": "India",
72        "modified_on": "2024-03-29T10:40:59.145000",
73        "verification_status": "pending",
74        "size_guide": "mufti-men-t-shirts-half-sleeve-polo-henley-hooded-round-neck",
75        "is_mnm": false,
76        "slug": "light-green-floral-print-mini-waffle-polo-t-shirt-9497176",
77        "collections": [],
78        "short_description": "Light Green Floral Print Mini Waffle Polo T-Shirt",
79        "_custom_json": {},
80        "product_online_date": "2023-07-20T09:51:23.530000",
81        "is_dependent": false,
82        "item_code": "MFK-9579-R-147-LIGHT GREEN",
83        "popularity": 871,
84        "multi_categories": [
85          {
86            "department": 21,
87            "is_active": true,
88            "l2": 2,
89            "l1": 442,
90            "l3": 192
91          }
92        ],
93        "modified_by": {
94          "username": "test_example_com_12345",
95          "user_id": "dea3b006029fd6724a0e2798",
96          "super_user": false
97        },
98        "departments": [
99          21
100        ],
101        "l3_categories": [
102          192
103        ],
104        "l3_category_names": [
105          "T-Shirts"
106        ],
107        "highlights": [],
108        "videos": [],
109        "store_ids": [
110          23630
111        ],
112        "custom_order": {
113          "is_custom_order": false,
114          "manufacturing_time_unit": "days",
115          "manufacturing_time": 0
116        },
117        "price": {
118          "effective": {
119            "min": 2299,
120            "max": 2299
121          },
122          "marked": {
123            "min": 2299,
124            "max": 2299
125          },
126          "currency": "INR",
127          "selling": {
128            "min": 2299,
129            "max": 2299
130          }
131        },
132        "sizes": [
133          "M"
134        ],
135        "is_set": false,
136        "all_company_ids": [],
137        "image_nature": "standard",
138        "all_sizes": [
139          "M",
140          "L",
141          "XL",
142          "3XL",
143          "4XL",
144          "2XL"
145        ],
146        "no_of_boxes": 1,
147        "multi_size": true,
148        "variants": {},
149        "variant_media": {},
150        "name": "Light Green Floral Print Mini Waffle Polo T-Shirt",
151        "created_on": "2023-07-20T09:51:47.892000",
152        "product_group_tag": [],
153        "tags": [
154          "AW-23"
155        ],
156        "quantity": 201,
157        "all_identifiers": [
158          "8905310320461",
159          "8905310320515",
160          "8905310320508",
161          "8905310320485",
162          "8905310320478",
163          "8905310320492"
164        ],
165        "is_promotional": false,
166        "media": [
167          {
168            "type": "image",
169            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/y_xY2Pb8ys-MFK-9579-R-147-LIGHT-GREEN-1.jpg",
170            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
171          },
172          {
173            "type": "image",
174            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/mk8o-XK1Jx-MFK-9579-R-147-LIGHT-GREEN-2.jpg",
175            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
176          },
177          {
178            "type": "image",
179            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/igZ__oe01F-MFK-9579-R-147-LIGHT-GREEN-3.jpg",
180            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
181          },
182          {
183            "type": "image",
184            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/a4yCoa0FpT-MFK-9579-R-147-LIGHT-GREEN-4.jpg",
185            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
186          },
187          {
188            "type": "image",
189            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/8K7WedADzq-MFK-9579-R-147-LIGHT-GREEN-5.jpg",
190            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
191          },
192          {
193            "type": "image",
194            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/Qhidbc7rEQ-MFK-9579-R-147-LIGHT-GREEN-6.jpg",
195            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
196          },
197          {
198            "type": "image",
199            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/8905310320461/Bm_m0AMJS-MFK-9579-R-147-LIGHT-GREEN-7.jpg",
200            "alt": "Light Green Floral Print Mini Waffle Polo T-Shirt"
201          }
202        ],
203        "uid": 9497176,
204        "platforms": {
205          "fynd": false,
206          "uniket_wholesale": false,
207          "ondc": false
208        },
209        "all_store_ids": [],
210        "company_ids": [
211          3932
212        ],
213        "expiration_date": "9998-01-30T23:59:00",
214        "identifier": {
215          "ean": [
216            "8905310320492",
217            "8905310320485",
218            "8905310320515",
219            "8905310320478",
220            "8905310320461",
221            "8905310320508"
222          ]
223        },
224        "out_of_stock": false,
225        "teaser_tag": {},
226        "store_id_list": [
227          "23630"
228        ],
229        "sellable_quantity": 1,
230        "company_id_list": [
231          "3932"
232        ],
233        "article_identifiers": [
234          "8905310320461"
235        ],
236        "sizes_with_price": [
237          {
238            "size": "M",
239            "identifiers": [
240              {
241                "gtin_type": "ean",
242                "gtin_value": "8905310320461"
243              }
244            ],
245            "quantity": 1
246          }
247        ],
248        "is_available": true,
249        "zone_identifier": "_all_",
250        "channel_identifier": "6544ddbd1a0e93369133a063",
251        "category_uid": 192,
252        "category_slug": "t-shirts",
253        "net_quantity": "{}",
254        "moq": {
255          "minimum": 1,
256          "increment_unit": 1
257        },
258        "seo": {
259          "title": "Light Green Floral Print Mini Waffle Polo T-Shirt",
260          "description": "Light Green Floral Print Mini Waffle Polo T-Shirt"
261        },
262        "_custom_meta": [
263          {
264            "key": "rating_user_count",
265            "value": "3452"
266          },
267          {
268            "key": "rating_user_count",
269            "value": "3452"
270          }
271        ]
272      }
273    ]
274  }
275}

application/product/delete/v1

this event is triggered when product 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
Payload containing product information
Properties
product
array of object
Required
Array of products
Array of Properties
item_id
string
Required
ID of the item
name
string
Required
Name of the product.
slug
string
Required
Unique slug for the product.
image_nature
string
Required
The nature of the product's images.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
item_type
string
Required
Type of the product.
is_custom_order
boolean
Required
Flag indicating if the product is a custom order.
channel_identifier
string
Required
Identifier for a channel.
zone_identifier
string
Identifier for a zone.
category_hierarchy
array of string
Hierarchy of categories associated with the product.
l1_category_names
array of string
Names of L1 categories associated with the product.
l2_category_names
array of string
Names of L2 categories associated with the product.
l3_category_names
array of string
Names of L3 categories associated with the product.
l3_categories
array of string
L3 categories associated with the product.
l1_category_slugs
array of string
Slugs of L1 categories associated with the product.
l2_category_slugs
array of string
Slugs of L2 categories associated with the product.
l3_category_slugs
array of string
Slugs of L3 categories associated with the product.
categories
array of string
Categories associated with the product.
categories_slug
array of string
Slugs of categories associated with the product.
departments
array of string
Required
List of department IDs associated with the product.
created_on
string
Required
The date and time when the product was created
modified_on
string
Required
The date and time when the product was last modified
is_tryout
boolean
Required
Flag indicating if the product is a tryout.
brand
string
The brand details of the product.
brand_slug
string
The brand slug of the product.
brand_id
integer
The brand UID of the product.
item_code
string
Required
Item code for the product.
discount
number
Discount applied to the product.
size_depth
number
Depth of the product size.
sizes
array of string
The sizes data of the product.
short_description
string
A short description of the product, limited to 50 characters.
country_of_origin
string
Country of origin for the product.
is_available
boolean
Product availability status on the basis of inventory configuration
product_online_date
string
The date on which the product will be live on platform
verification_status
string
The verification status of the product.
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
company_id_list
array of string
Required
List of company ids in the which the products has inventory
store_id_list
array of string
Required
List of store ids in the which the products has inventory
uid
integer
Required
The unique identifier of the product.
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": "Payload containing product information",
77      "properties": {
78        "product": {
79          "type": "array",
80          "description": "Array of products",
81          "items": {
82            "type": "object",
83            "description": "Individual product details",
84            "properties": {
85              "item_id": {
86                "type": "string",
87                "description": "ID of the item"
88              },
89              "name": {
90                "type": "string",
91                "description": "Name of the product."
92              },
93              "slug": {
94                "type": "string",
95                "description": "Unique slug for the product."
96              },
97              "image_nature": {
98                "type": "string",
99                "description": "The nature of the product's images."
100              },
101              "is_set": {
102                "type": "boolean",
103                "description": "Flag to indicate if the product is a set or not."
104              },
105              "item_type": {
106                "type": "string",
107                "description": "Type of the product."
108              },
109              "is_custom_order": {
110                "type": "boolean",
111                "description": "Flag indicating if the product is a custom order."
112              },
113              "channel_identifier": {
114                "type": "string",
115                "description": "Identifier for a channel."
116              },
117              "zone_identifier": {
118                "type": "string",
119                "description": "Identifier for a zone."
120              },
121              "category_hierarchy": {
122                "type": "array",
123                "description": "Hierarchy of categories associated with the product.",
124                "items": {
125                  "type": "string"
126                }
127              },
128              "l1_category_names": {
129                "type": "array",
130                "description": "Names of L1 categories associated with the product.",
131                "items": {
132                  "type": "string"
133                }
134              },
135              "l2_category_names": {
136                "type": "array",
137                "description": "Names of L2 categories associated with the product.",
138                "items": {
139                  "type": "string"
140                }
141              },
142              "l3_category_names": {
143                "type": "array",
144                "description": "Names of L3 categories associated with the product.",
145                "items": {
146                  "type": "string"
147                }
148              },
149              "l3_categories": {
150                "type": "array",
151                "description": "L3 categories associated with the product.",
152                "items": {
153                  "type": "string"
154                }
155              },
156              "l1_category_slugs": {
157                "type": "array",
158                "description": "Slugs of L1 categories associated with the product.",
159                "items": {
160                  "type": "string"
161                }
162              },
163              "l2_category_slugs": {
164                "type": "array",
165                "description": "Slugs of L2 categories associated with the product.",
166                "items": {
167                  "type": "string"
168                }
169              },
170              "l3_category_slugs": {
171                "type": "array",
172                "description": "Slugs of L3 categories associated with the product.",
173                "items": {
174                  "type": "string"
175                }
176              },
177              "categories": {
178                "type": "array",
179                "description": "Categories associated with the product.",
180                "items": {
181                  "type": "string"
182                }
183              },
184              "categories_slug": {
185                "type": "array",
186                "description": "Slugs of categories associated with the product.",
187                "items": {
188                  "type": "string"
189                }
190              },
191              "departments": {
192                "type": "array",
193                "description": "List of department IDs associated with the product.",
194                "items": {
195                  "type": "string"
196                }
197              },
198              "created_on": {
199                "type": "string",
200                "description": "The date and time when the product was created"
201              },
202              "modified_on": {
203                "type": "string",
204                "description": "The date and time when the product was last modified"
205              },
206              "is_tryout": {
207                "type": "boolean",
208                "description": "Flag indicating if the product is a tryout."
209              },
210              "brand": {
211                "type": "string",
212                "description": "The brand details of the product."
213              },
214              "brand_slug": {
215                "type": "string",
216                "description": "The brand slug of the product."
217              },
218              "brand_id": {
219                "type": "integer",
220                "description": "The brand UID of the product."
221              },
222              "item_code": {
223                "type": "string",
224                "description": "Item code for the product."
225              },
226              "discount": {
227                "type": "number",
228                "description": "Discount applied to the product."
229              },
230              "size_depth": {
231                "type": "number",
232                "description": "Depth of the product size."
233              },
234              "sizes": {
235                "type": "array",
236                "description": "The sizes data of the product.",
237                "items": {
238                  "type": "string"
239                }
240              },
241              "short_description": {
242                "type": "string",
243                "description": "A short description of the product, limited to 50 characters."
244              },
245              "country_of_origin": {
246                "type": "string",
247                "description": "Country of origin for the product."
248              },
249              "is_available": {
250                "type": "boolean",
251                "description": "Product availability status on the basis of inventory configuration"
252              },
253              "product_online_date": {
254                "type": "string",
255                "description": "The date on which the product will be live on platform"
256              },
257              "verification_status": {
258                "type": "string",
259                "description": "The verification status of the product."
260              },
261              "is_dependent": {
262                "type": "boolean",
263                "description": "Flag to indicate if the product is dependent on other products or not."
264              },
265              "company_id_list": {
266                "type": "array",
267                "description": "List of company ids in the which the products has inventory",
268                "items": {
269                  "type": "string"
270                }
271              },
272              "store_id_list": {
273                "type": "array",
274                "description": "List of store ids in the which the products has inventory",
275                "items": {
276                  "type": "string"
277                }
278              },
279              "uid": {
280                "type": "integer",
281                "description": "The unique identifier of the product."
282              }
283            },
284            "required": [
285              "item_id",
286              "name",
287              "slug",
288              "image_nature",
289              "is_set",
290              "item_type",
291              "is_custom_order",
292              "channel_identifier",
293              "departments",
294              "created_on",
295              "modified_on",
296              "is_tryout",
297              "item_code",
298              "is_dependent",
299              "company_id_list",
300              "store_id_list",
301              "uid"
302            ]
303          }
304        }
305      },
306      "required": [
307        "product"
308      ]
309    }
310  }
311}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.9916a5f8-edab-11ee-b8c8-368914e85a2e"
5    ],
6    "name": "product",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711703175865,
10    "id": "NMjlcpFLUZ6uoTpoWhmxMCgSNl80ebJa4VS28dKQ/6s=",
11    "category": "application"
12  },
13  "company_id": 1,
14  "application_id": [
15    "5d63686df2a4f7806b76bb32",
16    "*"
17  ],
18  "contains": [
19    "product"
20  ],
21  "payload": {
22    "product": [
23      {
24        "id": "561254!5d63686df2a4f7806b76bb32!_all_",
25        "item_id": "561254",
26        "item_id_tg": [
27          "561254"
28        ],
29        "name": "MENS PACK OF 3 BOXERS",
30        "name_tg": [
31          "MENS PACK OF 3 BOXERS"
32        ],
33        "slug": "being-human-mens-pack-of-3-boxers-561254-c780c8",
34        "slug_tg": [
35          "being-human-mens-pack-of-3-boxers-561254-c780c8"
36        ],
37        "image_nature": "default",
38        "is_set": false,
39        "item_type": "standard",
40        "_custom_json": {},
41        "moq": "{\"minimum\": 1, \"increment_unit\": 1}",
42        "seo": "{\"title\": \"MENS PACK OF 3 BOXERS\", \"description\": \"\"}",
43        "alt_text": "{}",
44        "net_quantity": "{}",
45        "channel_identifier": "5d63686df2a4f7806b76bb32",
46        "zone_identifier": "_all_",
47        "attributes": [
48          "color|MULTI",
49          "gender|men",
50          "material|100% COTTON",
51          "primary_color|None",
52          "primary_material|Others",
53          "season|AW17"
54        ],
55        "attributes_values": [
56          "100% COTTON",
57          "AW17",
58          "MULTI",
59          "None",
60          "Others",
61          "men"
62        ],
63        "article_identifiers": "8903861386080|8903861386097|8903861386103|BHMBX6015@MULTI",
64        "category_hierarchy": [
65          "boxers",
66          "innerwear-nightwear",
67          "underwear"
68        ],
69        "l1_category_names": [
70          "Innerwear & Nightwear"
71        ],
72        "l2_category_names": [
73          "Underwear"
74        ],
75        "l3_category_names": [
76          "Boxers"
77        ],
78        "l3_category_names_tg": [
79          "Boxers"
80        ],
81        "l3_categories": [
82          "183"
83        ],
84        "l1_category_slugs": [
85          "innerwear-nightwear"
86        ],
87        "l2_category_slugs": [
88          "underwear"
89        ],
90        "l3_category_slugs": [
91          "boxers"
92        ],
93        "l3_category_slugs_tg": [
94          "boxers"
95        ],
96        "categories": [
97          "21",
98          "22",
99          "183"
100        ],
101        "categories_slug": [
102          "boxers",
103          "innerwear-nightwear",
104          "underwear"
105        ],
106        "departments": [
107          "fashion"
108        ],
109        "departments_tg": [
110          "fashion"
111        ],
112        "created_on": "2020-07-24T18:04:17.459Z",
113        "modified_on": "2023-04-26T11:25:20.497Z",
114        "is_tryout": false,
115        "brand": "Being Human",
116        "brand_tg": [
117          "Being Human"
118        ],
119        "brand_slug": "being-human",
120        "brand_slug_tg": [
121          "being-human"
122        ],
123        "brand_id": 1,
124        "item_code": "BHMBX6015@MULTI",
125        "item_code_tg": [
126          "BHMBX6015@MULTI"
127        ],
128        "popularity": 648,
129        "min_price_effective": "749,INR",
130        "max_price_effective": "1499,INR",
131        "min_price_marked": "1499,INR",
132        "max_price_marked": "1499,INR",
133        "discount": 50,
134        "size_depth": 3,
135        "sizes": [
136          "L",
137          "M",
138          "XL"
139        ],
140        "sizes_tg": [
141          "L",
142          "M",
143          "XL"
144        ],
145        "short_description": "",
146        "country_of_origin": "India",
147        "is_available": true,
148        "product_online_date": "2020-07-24T18:04:17.459Z",
149        "verification_status": "pending",
150        "is_dependent": false,
151        "identifiers": [
152          "BHMBX6015@MULTI",
153          "8903861386080",
154          "8903861386103",
155          "8903861386097"
156        ],
157        "identifiers_tg": [
158          "BHMBX6015@MULTI",
159          "8903861386080",
160          "8903861386103",
161          "8903861386097"
162        ],
163        "attr_season_s": "AW17",
164        "attr_season_s_tg": [
165          "AW17"
166        ],
167        "attr_gender_ss": [
168          "Men"
169        ],
170        "attr_gender_ss_tg": [
171          "Men"
172        ],
173        "attr_primary_color_s": "None",
174        "attr_primary_color_s_tg": [
175          "None"
176        ],
177        "attr_primary_material_s": "Others",
178        "attr_primary_material_s_tg": [
179          "Others"
180        ],
181        "attr_color_s": "MULTI",
182        "attr_color_s_tg": [
183          "MULTI"
184        ],
185        "attr_material_s": "100% COTTON",
186        "attr_material_s_tg": [
187          "100% COTTON"
188        ],
189        "signatureField": "e0db9621cb5ecd6f",
190        "is_custom_order": false,
191        "timestamp": "2024-02-01T10:23:01.173Z",
192        "company_id_list": [
193          "1"
194        ],
195        "_version_": 1789691671273799700,
196        "store_id_list": [
197          "1060",
198          "2793",
199          "3",
200          "4",
201          "4023",
202          "5"
203        ],
204        "score": 1,
205        "uid": 561254
206      }
207    ]
208  }
209}

application/product/update/v1

this event is triggered when product 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
Payload containing product information
Properties
product
array of object
Required
Array of products
Array of Properties
_id
string
The unique identifier for the product.
product_online_date
string
Required
The date on which the product will be live on platform
no_of_boxes
integer
Required
Number of boxes containing the product.
platforms
object
The platforms where the product is available.
Properties
fynd
boolean
Indicates whether the product is available on the Fynd platform.
uniket_wholesale
boolean
Indicates whether the product is available on the Uniket Wholesale platform.
ondc
boolean
Indicates whether the product is available on the ONDC platform.
media
array of object
List of media information associated with the product.
Array of Properties
url
string
URL of the media file
type
string
Type of the media file
alt
string
Alternative text for the media file
meta
object
Media information for the product media
item_code
string
Required
Item code for the product.
is_promotional
boolean
Flag indicating if the product is promotional.
description
string
Description of the product.
videos
array of object
List of videos associated with the product
Array of Properties
thumbnail
string
URL of the video thumbnail image
type
string
Type of video platform (e.g., YouTube)
url
string
URL of the embedded video
modified_on
string
The date and time when the product was last modified
teaser_tag
object
Teaser tag for the product.
Properties
tag
string
Tag for teaser of the product.
discount
number
Discount applied to the product.
short_description
string
A short description of the product, limited to 50 characters.
created_on
string
The date and time when the product was created
images
array of string
Images associated with the product.
popularity
integer
Popularity score of the product.
sizes
array of string
Required
The sizes data of the product.
is_set
boolean
Required
Flag to indicate if the product is a set or not.
meta
object
Metadata associated with the product.
Properties
service
string
Service metadata associated with the product.
multi_size
boolean
Required
Flag to indicate if the product has multiple sizes or not.
net_quantity
string
A nested object representing the net quantity of the product.
uid
integer
Required
The unique identifier of the product.
raw
object
Raw data associated with the product.
size_guide
string
URL to the size guide for the product.
brand_uid
integer
Required
Unique ID of the brand associated with the product.
template_tag
string
Required
The tag used for the product template.
attributes
object
Attributes of the product.
departments
array of integer
Required
List of department IDs associated with the product.
all_sizes
array of string
Required
All available sizes for the product.
highlights
array of string
A list of highlights or special features associated with the product.
item_type
string
Required
Type of the product.
slug
string
Required
Unique slug for the product.
all_company_ids
array of integer
Required
All company IDs associated with the product.
image_nature
string
Required
The nature of the product's images.
tags
array of string
List of tags associated with the product.
price
object
Required
Price of the item
Properties
effective
object
Required
The effective price of the product.
Properties
min
number
Required
The minimum effective price of the product.
max
number
Required
The maximum effective price of the product.
marked
object
Required
The marked price of the product.
Properties
min
number
Required
The minimum marked price of the product.
max
number
Required
The maximum marked price of the product.
currency
string
Required
The currency in which the prices are denoted.
selling
object
The selling price of the product.
Properties
min
number
Required
The minimum selling price of the product.
max
number
Required
The maximum selling price of the product.
store_ids
array of integer
IDs of the stores where the product is available.
multi_categories
array of object
Flag indicating if the product belongs to multiple categories.
Array of Properties
l3
integer
L3 category
is_active
boolean
Indicates if the category is active
department
integer
Department associated with the category
l2
integer
L2 category
l1
integer
L1 category
is_dependent
boolean
Required
Flag to indicate if the product is dependent on other products or not.
product_group_tag
array of string
Tag associated with the product group.
created_by
object
User who created the product.
Properties
username
string
Required
Username of the user who created the company
user_id
string
Required
User ID of the user who created the company
super_user
boolean
Flag indicating if the creator is a super user.
variant_media
object
A dictionary of media files associated with each variant of the product.
l3_category_names
array of string
Names of L3 categories associated with the product.
quantity
integer
Required
Quantity of the product.
country_of_origin
string
Required
Country of origin for the product.
variants
object
A dictionary of product variants, where the keys are variant names and the values are variant details.
custom_order
object
Custom order information for the product.
Properties
is_custom_order
boolean
Flag indicating if the product is a custom order or not.
manufacturing_time_unit
string
The unit of time used to measure the time required to manufacture the product.
manufacturing_time
integer
The time required to manufacture the product, in the specified time unit.
_custom_json
object
A dictionary of custom JSON data associated with the product.
name
string
Required
Name of the product.
l3_categories
array of integer
Required
L3 categories associated with the product.
all_identifiers
array of string
Required
All identifiers associated with the product.
modified_by
object
User who last modified the product.
Properties
username
string
Required
Username of the user who last modified the company
user_id
string
Required
User ID of the user who last modified the company
super_user
boolean
Flag indicating if the user is a super user.
verification_status
string
The verification status of the product.
all_store_ids
array of integer
List of IDs of all stores.
company_ids
array of integer
List of IDs of companies.
expiration_date
string
Required
Date when product expires.
identifier
object
Contains Product identifiers types with their values.
out_of_stock
boolean
Flag indicating if product is out of stock.
store_id_list
array of string
Required
List of store ids in the which the products has inventory
sellable_quantity
integer
Required
Quantity of product that is sellable.
company_id_list
array of string
Required
List of company ids in the which the products has inventory
article_identifiers
array of string
Identifiers for articles.
sizes_with_price
array of object
Sizes along with their prices.
Array of Properties
size
string
Size name
identifiers
array of object
Identifiers associated with the size
Array of Properties
gtin_type
string
Required
Type of GTIN
gtin_value
string
Required
Value of GTIN
quantity
integer
Quantity available for the size
is_available
boolean
Required
Product availability status on the basis of inventory configuration
zone_identifier
string
Identifier for a zone.
channel_identifier
string
Required
Identifier for a channel.
category_uid
integer
Required
The unique identifier of the category that the product belongs to.
category_slug
string
Required
Slug of the category associated with the product.
moq
object
Minimum Order Quantity (MOQ) refers to the smallest amount of a product that a supplier is willing to sell.
Properties
minimum
integer
The minimum quantity that can be ordered as part of the Minimum Order Quantity.
increment_unit
integer
The unit by which the Minimum Order Quantity can be increased.
seo
object
Search Engine Optimization (SEO) refers to the process of improving the visibility of a website or a web page in search engine results.
Properties
title
string
The title tag of a web page is an HTML element that specifies the title of the page. It is displayed on search engine results pages as the clickable headline for a given result.
description
string
The meta description tag of a web page is an HTML element that summarizes the content of the page. It is often displayed underneath the title tag on search engine results pages.
_custom_meta
array of object
Custom meta associated with the product
Array of Properties
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
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": "Payload containing product information",
77      "properties": {
78        "product": {
79          "type": "array",
80          "description": "Array of products",
81          "items": {
82            "type": "object",
83            "description": "Individual product details",
84            "properties": {
85              "_id": {
86                "type": "string",
87                "description": "The unique identifier for the product."
88              },
89              "product_online_date": {
90                "type": "string",
91                "description": "The date on which the product will be live on platform"
92              },
93              "no_of_boxes": {
94                "type": "integer",
95                "description": "Number of boxes containing the product."
96              },
97              "platforms": {
98                "type": "object",
99                "description": "The platforms where the product is available.",
100                "properties": {
101                  "fynd": {
102                    "type": "boolean",
103                    "description": "Indicates whether the product is available on the Fynd platform."
104                  },
105                  "uniket_wholesale": {
106                    "type": "boolean",
107                    "description": "Indicates whether the product is available on the Uniket Wholesale platform."
108                  },
109                  "ondc": {
110                    "type": "boolean",
111                    "description": "Indicates whether the product is available on the ONDC platform."
112                  }
113                }
114              },
115              "media": {
116                "type": "array",
117                "description": "List of media information associated with the product.",
118                "items": {
119                  "type": "object",
120                  "properties": {
121                    "url": {
122                      "type": "string",
123                      "description": "URL of the media file"
124                    },
125                    "type": {
126                      "type": "string",
127                      "description": "Type of the media file"
128                    },
129                    "alt": {
130                      "type": "string",
131                      "description": "Alternative text for the media file"
132                    },
133                    "meta": {
134                      "type": "object",
135                      "description": "Media information for the product media",
136                      "additionalProperties": true
137                    }
138                  }
139                }
140              },
141              "item_code": {
142                "type": "string",
143                "description": "Item code for the product."
144              },
145              "is_promotional": {
146                "type": "boolean",
147                "description": "Flag indicating if the product is promotional."
148              },
149              "description": {
150                "type": "string",
151                "description": "Description of the product."
152              },
153              "videos": {
154                "description": "List of videos associated with the product",
155                "type": "array",
156                "items": {
157                  "type": "object",
158                  "properties": {
159                    "thumbnail": {
160                      "description": "URL of the video thumbnail image",
161                      "type": "string"
162                    },
163                    "type": {
164                      "description": "Type of video platform (e.g., YouTube)",
165                      "type": "string"
166                    },
167                    "url": {
168                      "description": "URL of the embedded video",
169                      "type": "string"
170                    }
171                  }
172                }
173              },
174              "modified_on": {
175                "type": "string",
176                "description": "The date and time when the product was last modified"
177              },
178              "teaser_tag": {
179                "type": "object",
180                "description": "Teaser tag for the product.",
181                "properties": {
182                  "tag": {
183                    "type": "string",
184                    "description": "Tag for teaser of the product."
185                  }
186                }
187              },
188              "discount": {
189                "type": "number",
190                "description": "Discount applied to the product."
191              },
192              "short_description": {
193                "type": "string",
194                "description": "A short description of the product, limited to 50 characters."
195              },
196              "created_on": {
197                "type": "string",
198                "description": "The date and time when the product was created"
199              },
200              "images": {
201                "type": "array",
202                "description": "Images associated with the product.",
203                "items": {
204                  "type": "string"
205                }
206              },
207              "popularity": {
208                "type": "integer",
209                "description": "Popularity score of the product."
210              },
211              "sizes": {
212                "type": "array",
213                "description": "The sizes data of the product.",
214                "items": {
215                  "type": "string"
216                }
217              },
218              "is_set": {
219                "type": "boolean",
220                "description": "Flag to indicate if the product is a set or not."
221              },
222              "meta": {
223                "type": "object",
224                "description": "Metadata associated with the product.",
225                "properties": {
226                  "service": {
227                    "type": "string",
228                    "description": "Service metadata associated with the product."
229                  }
230                }
231              },
232              "multi_size": {
233                "type": "boolean",
234                "description": "Flag to indicate if the product has multiple sizes or not."
235              },
236              "net_quantity": {
237                "type": "string",
238                "description": "A nested object representing the net quantity of the product."
239              },
240              "uid": {
241                "type": "integer",
242                "description": "The unique identifier of the product."
243              },
244              "raw": {
245                "type": "object",
246                "description": "Raw data associated with the product."
247              },
248              "size_guide": {
249                "type": "string",
250                "description": "URL to the size guide for the product."
251              },
252              "brand_uid": {
253                "type": "integer",
254                "description": "Unique ID of the brand associated with the product."
255              },
256              "template_tag": {
257                "type": "string",
258                "description": "The tag used for the product template."
259              },
260              "attributes": {
261                "type": "object",
262                "description": "Attributes of the product."
263              },
264              "departments": {
265                "type": "array",
266                "description": "List of department IDs associated with the product.",
267                "items": {
268                  "type": "integer"
269                }
270              },
271              "all_sizes": {
272                "type": "array",
273                "description": "All available sizes for the product.",
274                "items": {
275                  "type": "string"
276                }
277              },
278              "highlights": {
279                "type": "array",
280                "description": "A list of highlights or special features associated with the product.",
281                "items": {
282                  "type": "string"
283                }
284              },
285              "item_type": {
286                "type": "string",
287                "description": "Type of the product."
288              },
289              "slug": {
290                "type": "string",
291                "description": "Unique slug for the product."
292              },
293              "all_company_ids": {
294                "type": "array",
295                "description": "All company IDs associated with the product.",
296                "items": {
297                  "type": "integer"
298                }
299              },
300              "image_nature": {
301                "type": "string",
302                "description": "The nature of the product's images."
303              },
304              "tags": {
305                "type": "array",
306                "description": "List of tags associated with the product.",
307                "items": {
308                  "type": "string"
309                }
310              },
311              "price": {
312                "type": "object",
313                "description": "Price of the item",
314                "properties": {
315                  "effective": {
316                    "type": "object",
317                    "description": "The effective price of the product.",
318                    "properties": {
319                      "min": {
320                        "type": "number",
321                        "description": "The minimum effective price of the product."
322                      },
323                      "max": {
324                        "type": "number",
325                        "description": "The maximum effective price of the product."
326                      }
327                    },
328                    "required": [
329                      "min",
330                      "max"
331                    ]
332                  },
333                  "marked": {
334                    "type": "object",
335                    "description": "The marked price of the product.",
336                    "properties": {
337                      "min": {
338                        "type": "number",
339                        "description": "The minimum marked price of the product."
340                      },
341                      "max": {
342                        "type": "number",
343                        "description": "The maximum marked price of the product."
344                      }
345                    },
346                    "required": [
347                      "min",
348                      "max"
349                    ]
350                  },
351                  "currency": {
352                    "type": "string",
353                    "description": "The currency in which the prices are denoted."
354                  },
355                  "selling": {
356                    "type": "object",
357                    "description": "The selling price of the product.",
358                    "properties": {
359                      "min": {
360                        "type": "number",
361                        "description": "The minimum selling price of the product."
362                      },
363                      "max": {
364                        "type": "number",
365                        "description": "The maximum selling price of the product."
366                      }
367                    },
368                    "required": [
369                      "min",
370                      "max"
371                    ]
372                  }
373                },
374                "required": [
375                  "effective",
376                  "marked",
377                  "currency"
378                ]
379              },
380              "store_ids": {
381                "type": "array",
382                "description": "IDs of the stores where the product is available.",
383                "items": {
384                  "type": "integer"
385                }
386              },
387              "multi_categories": {
388                "type": "array",
389                "description": "Flag indicating if the product belongs to multiple categories.",
390                "items": {
391                  "type": "object",
392                  "properties": {
393                    "l3": {
394                      "type": "integer",
395                      "description": "L3 category"
396                    },
397                    "is_active": {
398                      "type": "boolean",
399                      "description": "Indicates if the category is active"
400                    },
401                    "department": {
402                      "type": "integer",
403                      "description": "Department associated with the category"
404                    },
405                    "l2": {
406                      "type": "integer",
407                      "description": "L2 category"
408                    },
409                    "l1": {
410                      "type": "integer",
411                      "description": "L1 category"
412                    }
413                  }
414                }
415              },
416              "is_dependent": {
417                "type": "boolean",
418                "description": "Flag to indicate if the product is dependent on other products or not."
419              },
420              "product_group_tag": {
421                "type": "array",
422                "description": "Tag associated with the product group.",
423                "items": {
424                  "type": "string"
425                }
426              },
427              "created_by": {
428                "type": "object",
429                "description": "User who created the product.",
430                "properties": {
431                  "username": {
432                    "type": "string",
433                    "description": "Username of the user who created the company"
434                  },
435                  "user_id": {
436                    "type": "string",
437                    "description": "User ID of the user who created the company"
438                  },
439                  "super_user": {
440                    "type": "boolean",
441                    "description": "Flag indicating if the creator is a super user."
442                  }
443                },
444                "required": [
445                  "username",
446                  "user_id"
447                ]
448              },
449              "variant_media": {
450                "type": "object",
451                "description": "A dictionary of media files associated with each variant of the product."
452              },
453              "l3_category_names": {
454                "type": "array",
455                "description": "Names of L3 categories associated with the product.",
456                "items": {
457                  "type": "string"
458                }
459              },
460              "quantity": {
461                "type": "integer",
462                "description": "Quantity of the product."
463              },
464              "country_of_origin": {
465                "type": "string",
466                "description": "Country of origin for the product."
467              },
468              "variants": {
469                "type": "object",
470                "description": "A dictionary of product variants, where the keys are variant names and the values are variant details."
471              },
472              "custom_order": {
473                "type": "object",
474                "description": "Custom order information for the product.",
475                "properties": {
476                  "is_custom_order": {
477                    "type": "boolean",
478                    "description": "Flag indicating if the product is a custom order or not."
479                  },
480                  "manufacturing_time_unit": {
481                    "type": "string",
482                    "description": "The unit of time used to measure the time required to manufacture the product."
483                  },
484                  "manufacturing_time": {
485                    "type": "integer",
486                    "description": "The time required to manufacture the product, in the specified time unit."
487                  }
488                }
489              },
490              "_custom_json": {
491                "type": "object",
492                "description": "A dictionary of custom JSON data associated with the product."
493              },
494              "name": {
495                "type": "string",
496                "description": "Name of the product."
497              },
498              "l3_categories": {
499                "type": "array",
500                "description": "L3 categories associated with the product.",
501                "items": {
502                  "type": "integer"
503                }
504              },
505              "all_identifiers": {
506                "type": "array",
507                "description": "All identifiers associated with the product.",
508                "items": {
509                  "type": "string"
510                }
511              },
512              "modified_by": {
513                "type": "object",
514                "description": "User who last modified the product.",
515                "properties": {
516                  "username": {
517                    "type": "string",
518                    "description": "Username of the user who last modified the company"
519                  },
520                  "user_id": {
521                    "type": "string",
522                    "description": "User ID of the user who last modified the company"
523                  },
524                  "super_user": {
525                    "type": "boolean",
526                    "description": "Flag indicating if the user is a super user."
527                  }
528                },
529                "required": [
530                  "username",
531                  "user_id"
532                ]
533              },
534              "verification_status": {
535                "type": "string",
536                "description": "The verification status of the product."
537              },
538              "all_store_ids": {
539                "type": "array",
540                "description": "List of IDs of all stores.",
541                "items": {
542                  "type": "integer"
543                }
544              },
545              "company_ids": {
546                "type": "array",
547                "description": "List of IDs of companies.",
548                "items": {
549                  "type": "integer"
550                }
551              },
552              "expiration_date": {
553                "type": "string",
554                "description": "Date when product expires."
555              },
556              "identifier": {
557                "type": "object",
558                "additionalProperties": true,
559                "description": "Contains Product identifiers types with their values.",
560                "example": {
561                  "ean": [
562                    "8011003804542"
563                  ],
564                  "alu": [
565                    "000000000490936300",
566                    "0000000006167126612",
567                    "0000000001872378232"
568                  ],
569                  "sku": [
570                    "SKU12345",
571                    "SKU67890"
572                  ]
573                }
574              },
575              "out_of_stock": {
576                "type": "boolean",
577                "description": "Flag indicating if product is out of stock."
578              },
579              "store_id_list": {
580                "type": "array",
581                "description": "List of store ids in the which the products has inventory",
582                "items": {
583                  "type": "string"
584                }
585              },
586              "sellable_quantity": {
587                "type": "integer",
588                "description": "Quantity of product that is sellable."
589              },
590              "company_id_list": {
591                "type": "array",
592                "description": "List of company ids in the which the products has inventory",
593                "items": {
594                  "type": "string"
595                }
596              },
597              "article_identifiers": {
598                "type": "array",
599                "description": "Identifiers for articles.",
600                "items": {
601                  "type": "string"
602                }
603              },
604              "sizes_with_price": {
605                "type": "array",
606                "description": "Sizes along with their prices.",
607                "items": {
608                  "type": "object",
609                  "properties": {
610                    "size": {
611                      "type": "string",
612                      "description": "Size name"
613                    },
614                    "identifiers": {
615                      "type": "array",
616                      "description": "Identifiers associated with the size",
617                      "items": {
618                        "type": "object",
619                        "properties": {
620                          "gtin_type": {
621                            "type": "string",
622                            "description": "Type of GTIN"
623                          },
624                          "gtin_value": {
625                            "type": "string",
626                            "description": "Value of GTIN"
627                          }
628                        },
629                        "required": [
630                          "gtin_type",
631                          "gtin_value"
632                        ]
633                      }
634                    },
635                    "quantity": {
636                      "type": "integer",
637                      "description": "Quantity available for the size"
638                    }
639                  }
640                }
641              },
642              "is_available": {
643                "type": "boolean",
644                "description": "Product availability status on the basis of inventory configuration"
645              },
646              "zone_identifier": {
647                "type": "string",
648                "description": "Identifier for a zone."
649              },
650              "channel_identifier": {
651                "type": "string",
652                "description": "Identifier for a channel."
653              },
654              "category_uid": {
655                "type": "integer",
656                "description": "The unique identifier of the category that the product belongs to."
657              },
658              "category_slug": {
659                "type": "string",
660                "description": "Slug of the category associated with the product."
661              },
662              "moq": {
663                "type": "object",
664                "description": "Minimum Order Quantity (MOQ) refers to the smallest amount of a product that a supplier is willing to sell.",
665                "properties": {
666                  "minimum": {
667                    "type": "integer",
668                    "description": "The minimum quantity that can be ordered as part of the Minimum Order Quantity."
669                  },
670                  "increment_unit": {
671                    "type": "integer",
672                    "description": "The unit by which the Minimum Order Quantity can be increased."
673                  }
674                }
675              },
676              "seo": {
677                "type": "object",
678                "description": "Search Engine Optimization (SEO) refers to the process of improving the visibility of a website or a web page in search engine results.",
679                "properties": {
680                  "title": {
681                    "type": "string",
682                    "description": "The title tag of a web page is an HTML element that specifies the title of the page. It is displayed on search engine results pages as the clickable headline for a given result."
683                  },
684                  "description": {
685                    "type": "string",
686                    "description": "The meta description tag of a web page is an HTML element that summarizes the content of the page. It is often displayed underneath the title tag on search engine results pages."
687                  }
688                }
689              },
690              "_custom_meta": {
691                "type": "array",
692                "items": {
693                  "type": "object",
694                  "properties": {
695                    "key": {
696                      "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",
697                      "maxLength": 30,
698                      "minLength": 1,
699                      "type": "string"
700                    },
701                    "value": {
702                      "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",
703                      "maxLength": 100,
704                      "minLength": 1,
705                      "type": "string"
706                    }
707                  }
708                },
709                "description": "Custom meta associated with the product"
710              }
711            },
712            "required": [
713              "product_online_date",
714              "no_of_boxes",
715              "item_code",
716              "sizes",
717              "is_set",
718              "multi_size",
719              "uid",
720              "brand_uid",
721              "template_tag",
722              "departments",
723              "all_sizes",
724              "item_type",
725              "slug",
726              "all_company_ids",
727              "image_nature",
728              "price",
729              "is_dependent",
730              "quantity",
731              "country_of_origin",
732              "name",
733              "l3_categories",
734              "all_identifiers",
735              "expiration_date",
736              "store_id_list",
737              "sellable_quantity",
738              "company_id_list",
739              "is_available",
740              "channel_identifier",
741              "category_uid",
742              "category_slug"
743            ]
744          }
745        }
746      },
747      "required": [
748        "product"
749      ]
750    }
751  }
752}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.a6d19d16-f278-11ee-80ca-b6f8cc53a1b5"
5    ],
6    "name": "product",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712231050381,
10    "id": "6ik5aILDB5qcwB9041CBuKTtdYk+itZJXQ44z2eFl3I=",
11    "category": "application"
12  },
13  "company_id": 61,
14  "application_id": [
15    "64d20c6a651519af28e8607c",
16    "*"
17  ],
18  "contains": [
19    "product"
20  ],
21  "payload": {
22    "product": [
23      {
24        "_id": "56879a47a80ea94e8e80382f",
25        "uid": 23212,
26        "name": "Run S S Sulphur Spring T-Shirt",
27        "attributes": {
28          "essential": "No",
29          "color": "Sulphur Spring",
30          "gender": [
31            "Men"
32          ],
33          "occasion": "Athleisure",
34          "season": "AW15",
35          "material": "Polyester",
36          "pattern": "Printed",
37          "care_instructions": "Machine wash on normal cycle",
38          "primary_color": "Yellow",
39          "primary_material": "Polyester",
40          "net-quantity": "1 N",
41          "marketer-name": "SSIPL Lifestyle Pvt Ltd",
42          "marketer-address": "dummy data",
43          "name": "Run S S Sulphur Spring T-Shirt",
44          "description": "Having created fashion-forward clothes and accessories since the end of the last century, Puma introduces their autumn-winter collection designed for comfort and style. Combining the best in design and utility, it's no wonder that Puma is one of the world's leading sports brands, designing, developing, selling and marketing footwear, apparel and accessories.",
45          "product_details": "Having created fashion-forward clothes and accessories since the end of the last century, Puma introduces their autumn-winter collection designed for comfort and style. Combining the best in design and utility, it's no wonder that Puma is one of the world's leading sports brands, designing, developing, selling and marketing footwear, apparel and accessories.",
46          "brand_name": "Puma",
47          "primary_color_hex": "FDE425",
48          "primary-colour-hex-code": "FDE425"
49        },
50        "images": [
51          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/UXAGvgk-TC-1.jpg",
52          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/FvmgbwUvZf-2.jpg",
53          "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/umeELhNhXr-3.jpg"
54        ],
55        "created_on": "2022-09-22T12:11:41.516000",
56        "modified_on": "2024-04-04T11:44:07.091000",
57        "item_code": "51306003",
58        "is_active": true,
59        "is_mnm": false,
60        "discount": 0,
61        "quantity": 3187,
62        "branch_url": "http://go.fyndi.ng/iSyg/v13ocBi4cy",
63        "hsn_code": "61091000",
64        "is_default_hsn_code": false,
65        "popularity": 541,
66        "multi_categories": [
67          {
68            "l1": 442,
69            "l3": 192,
70            "l2": 2,
71            "department": 21,
72            "is_active": true
73          }
74        ],
75        "l3_category_names": [
76          "T-Shirts"
77        ],
78        "l3_categories": [
79          192
80        ],
81        "departments": [
82          21
83        ],
84        "brand_uid": 9,
85        "store_ids": [
86          10214,
87          10553,
88          11319,
89          11354,
90          11500,
91          11625,
92          13444,
93          15011,
94          15411,
95          15495,
96          16262,
97          16268,
98          16271,
99          16272,
100          16273,
101          17268,
102          17269,
103          17312,
104          23672,
105          23674
106        ],
107        "price": {
108          "effective": {
109            "min": 1799,
110            "max": 1799
111          },
112          "marked": {
113            "min": 1799,
114            "max": 1799
115          },
116          "currency": "INR",
117          "selling": {
118            "min": 1799,
119            "max": 1799
120          }
121        },
122        "sizes": [
123          "L",
124          "XL",
125          "XXL"
126        ],
127        "meta_nature": "standard",
128        "image_nature": "standard",
129        "special_badge": "",
130        "aliases": [],
131        "slug": "puma-run-s-s-sulphur-spring-t-shirt",
132        "pack_of": 1,
133        "platforms": {
134          "fynd": false,
135          "uniket_wholesale": false,
136          "ondc": true
137        },
138        "variants": {},
139        "company_ids": [
140          61
141        ],
142        "is_set": false,
143        "_custom_json": {},
144        "raw": {},
145        "videos": [],
146        "all_company_ids": [],
147        "all_identifiers": [
148          "4055262572747",
149          "4055262573188",
150          "4055262572785"
151        ],
152        "all_sizes": [
153          "L",
154          "XL",
155          "XXL"
156        ],
157        "template_tag": "topwear",
158        "country_of_origin": "India",
159        "created_by": {
160          "username": "918888888888_12345",
161          "user_id": "5f11db42d6f10d71b9cd3c65",
162          "super_user": false
163        },
164        "description": "Having created fashion-forward clothes and accessories since the end of the last century, Puma introduces their autumn-winter collection designed for comfort and style. Combining the best in design and utility, it's no wonder that Puma is one of the world's leading sports brands, designing, developing, selling and marketing footwear, apparel and accessories.",
165        "media": [
166          {
167            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/UXAGvgk-TC-1.jpg",
168            "type": "image",
169            "alt": "Run S S Sulphur Spring T-Shirt"
170          },
171          {
172            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/FvmgbwUvZf-2.jpg",
173            "type": "image",
174            "alt": "Run S S Sulphur Spring T-Shirt"
175          },
176          {
177            "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/original/4055262573188/umeELhNhXr-3.jpg",
178            "type": "image",
179            "alt": "Run S S Sulphur Spring T-Shirt"
180          }
181        ],
182        "meta": {
183          "service": "Silverbolt"
184        },
185        "modified_by": {
186          "username": "918888888888_12345",
187          "user_id": "5f11db42d6f10d71b9cd3c65",
188          "super_user": false
189        },
190        "all_store_ids": [],
191        "out_of_stock": false,
192        "size_guide": "puma-men-casual-tees",
193        "is_dependent": false,
194        "item_type": "standard",
195        "multi_size": true,
196        "product_online_date": "2022-09-21T12:25:45.177000",
197        "no_of_boxes": 1,
198        "expiration_date": "9998-01-30T23:59:00",
199        "custom_order": {
200          "manufacturing_time_unit": "days",
201          "is_custom_order": false,
202          "manufacturing_time": 0
203        },
204        "highlights": [],
205        "moq": {
206          "minimum": 1,
207          "increment_unit": 1
208        },
209        "product_group_tag": [],
210        "short_description": "",
211        "tags": [],
212        "verification_status": "pending",
213        "identifier": {
214          "upc": [
215            "4055262573188",
216            "4055262572785",
217            "4055262572747"
218          ]
219        },
220        "date_meta": {
221          "modified_on": "2023-06-14T17:44:40.533000"
222        },
223        "store_id_list": [
224          "10214",
225          "10553",
226          "11319",
227          "11354",
228          "11500",
229          "11625",
230          "13444",
231          "15011",
232          "15411",
233          "15495",
234          "16262",
235          "16268",
236          "16271",
237          "16272",
238          "16273",
239          "17268",
240          "17269",
241          "17312",
242          "23672",
243          "23674"
244        ],
245        "sellable_quantity": 3187,
246        "company_id_list": [
247          "61",
248          "61"
249        ],
250        "article_identifiers": [
251          "4055262572747",
252          "4055262572785",
253          "4055262573188"
254        ],
255        "sizes_with_price": [
256          {
257            "size": "L",
258            "identifiers": [
259              {
260                "gtin_type": "upc",
261                "gtin_value": "4055262572785"
262              }
263            ],
264            "quantity": 1077
265          },
266          {
267            "size": "XL",
268            "identifiers": [
269              {
270                "gtin_type": "upc",
271                "gtin_value": "4055262573188"
272              }
273            ],
274            "quantity": 1055
275          },
276          {
277            "size": "XXL",
278            "identifiers": [
279              {
280                "gtin_type": "upc",
281                "gtin_value": "4055262572747"
282              }
283            ],
284            "quantity": 1055
285          }
286        ],
287        "is_available": true,
288        "zone_identifier": "_all_",
289        "channel_identifier": "64d20c6a651519af28e8607c",
290        "category_uid": 192,
291        "category_slug": "t-shirts",
292        "net_quantity": "{}",
293        "seo": {
294          "title": "Run S S Sulphur Spring T-Shirt",
295          "description": ""
296        },
297        "_custom_meta": [
298          {
299            "key": "rating_user_count",
300            "value": "3452"
301          },
302          {
303            "key": "rating_user_count",
304            "value": "3452"
305          }
306        ]
307      }
308    ]
309  }
310}

application/product/create/v2

this event is triggered when product 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
product
array of object
Array of Properties
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object
The brand associated with the product.
Properties
action
object
Schema to define the Action Object
Properties
type
string
Type of action to be taken e.g, page.
page
object
Represents the page details used for rendering.
Properties
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
string
Required
The type of action such as product, products, category, brand.
Enum
popup
object
Represents the page details used for rendering.
Properties
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
string
Required
The type of action such as product, products, category, brand.
Enum
logo
object
Media information about the product, including metadata, type, URL, and alternative text.
Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
Required
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
Required
A unique code assigned to the product item at company and brand level.
item_type
string
Required
The type of the product, defining its nature.
Enum
medias
array of object
A list of media items associated with the product, such as images or videos.
Array of Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Required
The name of the product.
price
Undefined Type
The pricing details of the product.
Properties
effective
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
Required
A URL-friendly string representing the product.
teaser_tag
string
A teaser tag string providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
Required
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
Required
The unique identifier for the brand associated with the product.
category_uid
integer
Required
The unique identifier for the category to which the product belongs.
verification_status
string
Verification status of the product.
Enum
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
Required
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
Required
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Required
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Required
Indicates whether the product can be considered as a gift.
is_cod
boolean
Required
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Required
Indicates whether the product depends on another product.
is_available
boolean
Required
Indicates whether the product is currently available for purchase.
moq
object
Required
The order quantity details required to purchase the product.
Properties
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object
Required
The SEO details related to the product, including metadata for search engine optimization.
Properties
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object
Properties
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object
Array of Properties
url
string
action
object
Properties
page
object
type
string
Required
meta_tags
array of object
Array of Properties
title
string
Required
items
array of object
Array of Properties
key
string
Required
value
string
Required
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object
Array of Properties
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
Enum
value
number
The numerical value representing the net quantity of the product.
custom_order
object
Custom order details for the product.
Properties
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Required
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object
Custom meta associated with the product.
Array of Properties
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
no_of_boxes
integer
Number of boxes containing the product.
created_on
string
| date-time
The date and time when the product was created
modified_on
string
| date-time
The date and time when the product was last modified
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      "properties": {
77        "product": {
78          "type": "array",
79          "items": {
80            "type": "object",
81            "properties": {
82              "attributes": {
83                "type": "object",
84                "additionalProperties": true,
85                "description": "Additional attributes of the product, such as custom properties or features."
86              },
87              "brand": {
88                "properties": {
89                  "action": {
90                    "type": "object",
91                    "description": "Schema to define the Action Object",
92                    "properties": {
93                      "type": {
94                        "type": "string",
95                        "description": "Type of action to be taken e.g, page.",
96                        "example": "test"
97                      },
98                      "page": {
99                        "type": "object",
100                        "description": "Represents the page details used for rendering.",
101                        "required": [
102                          "type"
103                        ],
104                        "properties": {
105                          "params": {
106                            "type": "object",
107                            "description": "Parameters that should be considered in path.",
108                            "additionalProperties": {
109                              "type": "array",
110                              "items": {
111                                "type": "string",
112                                "description": "A string parameter for the action."
113                              }
114                            }
115                          },
116                          "query": {
117                            "type": "object",
118                            "description": "Query parameter if any to be added to the action.",
119                            "additionalProperties": {
120                              "type": "array",
121                              "items": {
122                                "type": "string",
123                                "description": "A string query parameter for the action."
124                              }
125                            }
126                          },
127                          "url": {
128                            "type": "string",
129                            "description": "The URL for the action."
130                          },
131                          "type": {
132                            "type": "string",
133                            "description": "The type of action such as product, products, category, brand.",
134                            "enum": [
135                              "about-us",
136                              "addresses",
137                              "blog",
138                              "brands",
139                              "cards",
140                              "cart",
141                              "categories",
142                              "brand",
143                              "category",
144                              "collection",
145                              "collections",
146                              "custom",
147                              "contact-us",
148                              "external",
149                              "faq",
150                              "freshchat",
151                              "home",
152                              "notification-settings",
153                              "orders",
154                              "page",
155                              "policy",
156                              "product",
157                              "product-request",
158                              "products",
159                              "profile",
160                              "profile-order-shipment",
161                              "profile-basic",
162                              "profile-company",
163                              "profile-emails",
164                              "profile-phones",
165                              "rate-us",
166                              "refer-earn",
167                              "settings",
168                              "shared-cart",
169                              "tnc",
170                              "track-order",
171                              "wishlist",
172                              "sections",
173                              "form",
174                              "cart-delivery",
175                              "cart-payment",
176                              "cart-review",
177                              "login",
178                              "register",
179                              "shipping-policy",
180                              "return-policy",
181                              "order-status",
182                              "locate-us"
183                            ]
184                          }
185                        }
186                      },
187                      "popup": {
188                        "type": "object",
189                        "description": "Represents the page details used for rendering.",
190                        "required": [
191                          "type"
192                        ],
193                        "properties": {
194                          "params": {
195                            "type": "object",
196                            "description": "Parameters that should be considered in path.",
197                            "additionalProperties": {
198                              "type": "array",
199                              "items": {
200                                "type": "string",
201                                "description": "A string parameter for the action."
202                              }
203                            }
204                          },
205                          "query": {
206                            "type": "object",
207                            "description": "Query parameter if any to be added to the action.",
208                            "additionalProperties": {
209                              "type": "array",
210                              "items": {
211                                "type": "string",
212                                "description": "A string query parameter for the action."
213                              }
214                            }
215                          },
216                          "url": {
217                            "type": "string",
218                            "description": "The URL for the action."
219                          },
220                          "type": {
221                            "type": "string",
222                            "description": "The type of action such as product, products, category, brand.",
223                            "enum": [
224                              "about-us",
225                              "addresses",
226                              "blog",
227                              "brands",
228                              "cards",
229                              "cart",
230                              "categories",
231                              "brand",
232                              "category",
233                              "collection",
234                              "collections",
235                              "custom",
236                              "contact-us",
237                              "external",
238                              "faq",
239                              "freshchat",
240                              "home",
241                              "notification-settings",
242                              "orders",
243                              "page",
244                              "policy",
245                              "product",
246                              "product-request",
247                              "products",
248                              "profile",
249                              "profile-order-shipment",
250                              "profile-basic",
251                              "profile-company",
252                              "profile-emails",
253                              "profile-phones",
254                              "rate-us",
255                              "refer-earn",
256                              "settings",
257                              "shared-cart",
258                              "tnc",
259                              "track-order",
260                              "wishlist",
261                              "sections",
262                              "form",
263                              "cart-delivery",
264                              "cart-payment",
265                              "cart-review",
266                              "login",
267                              "register",
268                              "shipping-policy",
269                              "return-policy",
270                              "order-status",
271                              "locate-us"
272                            ]
273                          }
274                        }
275                      }
276                    }
277                  },
278                  "logo": {
279                    "description": "Media information about the product, including metadata, type, URL, and alternative text.",
280                    "properties": {
281                      "meta": {
282                        "type": "object",
283                        "additionalProperties": true,
284                        "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."
285                      },
286                      "type": {
287                        "type": "string",
288                        "enum": [
289                          "image",
290                          "video",
291                          "3d_model"
292                        ],
293                        "description": "The type of media."
294                      },
295                      "url": {
296                        "type": "string",
297                        "description": "The URL where the media can be accessed."
298                      },
299                      "alt": {
300                        "type": "string",
301                        "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
302                      },
303                      "thumbnail": {
304                        "type": "string",
305                        "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
306                      }
307                    },
308                    "required": [
309                      "url"
310                    ],
311                    "type": "object"
312                  },
313                  "name": {
314                    "type": "string"
315                  },
316                  "uid": {
317                    "type": "integer"
318                  }
319                },
320                "type": "object",
321                "description": "The brand associated with the product."
322              },
323              "description": {
324                "type": "string",
325                "description": "A detailed description of the product."
326              },
327              "discount": {
328                "type": "string",
329                "description": "The discount applied to the product."
330              },
331              "has_variant": {
332                "type": "boolean",
333                "description": "Indicates whether the product has variants, such as different sizes or colors."
334              },
335              "highlights": {
336                "items": {
337                  "type": "string"
338                },
339                "type": "array",
340                "description": "Key highlights of the product."
341              },
342              "image_nature": {
343                "type": "string",
344                "enum": [
345                  "default",
346                  "standard"
347                ],
348                "description": "The nature of the product image, indicating if it's the default or a standard image."
349              },
350              "item_code": {
351                "type": "string",
352                "x-not-enum": true,
353                "description": "A unique code assigned to the product item at company and brand level."
354              },
355              "item_type": {
356                "type": "string",
357                "enum": [
358                  "composite",
359                  "digital",
360                  "packaging",
361                  "set",
362                  "standard"
363                ],
364                "description": "The type of the product, defining its nature."
365              },
366              "medias": {
367                "items": {
368                  "description": "Media information about the product, including metadata, type, URL, and alternative text.",
369                  "properties": {
370                    "meta": {
371                      "type": "object",
372                      "additionalProperties": true,
373                      "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."
374                    },
375                    "type": {
376                      "type": "string",
377                      "enum": [
378                        "image",
379                        "video",
380                        "3d_model"
381                      ],
382                      "description": "The type of media."
383                    },
384                    "url": {
385                      "type": "string",
386                      "description": "The URL where the media can be accessed."
387                    },
388                    "alt": {
389                      "type": "string",
390                      "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
391                    },
392                    "thumbnail": {
393                      "type": "string",
394                      "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
395                    }
396                  },
397                  "required": [
398                    "url"
399                  ],
400                  "type": "object"
401                },
402                "type": "array",
403                "description": "A list of media items associated with the product, such as images or videos."
404              },
405              "name": {
406                "type": "string",
407                "description": "The name of the product."
408              },
409              "price": {
410                "description": "The pricing details of the product.",
411                "properties": {
412                  "effective": {
413                    "properties": {
414                      "currency_code": {
415                        "type": "string",
416                        "description": "ISO 4217 currency codes",
417                        "x-not-enum": true
418                      },
419                      "currency_symbol": {
420                        "type": "string"
421                      },
422                      "max": {
423                        "type": "number"
424                      },
425                      "min": {
426                        "type": "number"
427                      }
428                    },
429                    "type": "object"
430                  },
431                  "marked": {
432                    "properties": {
433                      "currency_code": {
434                        "type": "string",
435                        "description": "ISO 4217 currency codes",
436                        "x-not-enum": true
437                      },
438                      "currency_symbol": {
439                        "type": "string"
440                      },
441                      "max": {
442                        "type": "number"
443                      },
444                      "min": {
445                        "type": "number"
446                      }
447                    },
448                    "type": "object"
449                  },
450                  "selling": {
451                    "properties": {
452                      "currency_code": {
453                        "type": "string",
454                        "description": "ISO 4217 currency codes",
455                        "x-not-enum": true
456                      },
457                      "currency_symbol": {
458                        "type": "string"
459                      },
460                      "max": {
461                        "type": "number"
462                      },
463                      "min": {
464                        "type": "number"
465                      }
466                    },
467                    "type": "object"
468                  }
469                }
470              },
471              "product_online_date": {
472                "format": "date-time",
473                "type": "string",
474                "description": "The date and time when the product becomes available online."
475              },
476              "promo_meta": {
477                "type": "object",
478                "additionalProperties": true,
479                "description": "Metadata related to any promotions associated with the product."
480              },
481              "rating": {
482                "type": "number",
483                "description": "The average rating of the product, typically based on customer reviews."
484              },
485              "rating_count": {
486                "type": "integer",
487                "description": "The total number of ratings the product has received."
488              },
489              "sellable": {
490                "type": "boolean",
491                "description": "Indicates whether the product is available for sale."
492              },
493              "short_description": {
494                "type": "string",
495                "description": "A brief description of the product."
496              },
497              "similars": {
498                "items": {
499                  "type": "string"
500                },
501                "type": "array",
502                "description": "A list of similar products."
503              },
504              "slug": {
505                "type": "string",
506                "description": "A URL-friendly string representing the product."
507              },
508              "teaser_tag": {
509                "type": "string",
510                "description": "A teaser tag string providing short promotional information about the product."
511              },
512              "tryouts": {
513                "items": {
514                  "type": "string"
515                },
516                "type": "array",
517                "description": "A list of tryout options or samples available for the product."
518              },
519              "type": {
520                "type": "string",
521                "description": "The type or category of the product."
522              },
523              "uid": {
524                "type": "integer",
525                "description": "A unique identifier for the product."
526              },
527              "popularity": {
528                "type": "integer",
529                "description": "A numerical value indicating the popularity of the product."
530              },
531              "brand_uid": {
532                "type": "integer",
533                "description": "The unique identifier for the brand associated with the product."
534              },
535              "category_uid": {
536                "type": "integer",
537                "description": "The unique identifier for the category to which the product belongs."
538              },
539              "verification_status": {
540                "type": "string",
541                "enum": [
542                  "pending",
543                  "verified",
544                  "rejected"
545                ],
546                "description": "Verification status of the product."
547              },
548              "channel_identifier": {
549                "type": "string",
550                "description": "The identifier for the sales channel through which the product is sold."
551              },
552              "category_slug": {
553                "type": "string",
554                "description": "A URL-friendly string representing the product's category."
555              },
556              "size_guide": {
557                "type": "string",
558                "description": "A guide or chart providing size information for the product."
559              },
560              "l3_categories": {
561                "type": "array",
562                "items": {
563                  "type": "integer"
564                },
565                "description": "A list of L3 category IDs of the product."
566              },
567              "store_ids": {
568                "type": "array",
569                "items": {
570                  "type": "integer"
571                },
572                "description": "A list of store IDs where the product is available."
573              },
574              "company_ids": {
575                "type": "array",
576                "items": {
577                  "type": "integer"
578                },
579                "description": "A list of company IDs associated with the product."
580              },
581              "departments": {
582                "type": "array",
583                "items": {
584                  "type": "integer"
585                },
586                "description": "A list of department IDs where the product is categorized."
587              },
588              "tags": {
589                "type": "array",
590                "items": {
591                  "type": "string"
592                },
593                "description": "A list of tags or keywords associated with the product."
594              },
595              "l3_category_names": {
596                "type": "array",
597                "items": {
598                  "type": "string"
599                },
600                "description": "A list of names of L3 categories of the product."
601              },
602              "sizes": {
603                "type": "array",
604                "items": {
605                  "type": "string"
606                },
607                "description": "A list of available sizes for the product."
608              },
609              "product_group_tag": {
610                "type": "array",
611                "items": {
612                  "type": "string"
613                },
614                "description": "Tags that group the product with other similar products."
615              },
616              "multi_size": {
617                "type": "boolean",
618                "description": "Indicates whether the product is available in multiple sizes."
619              },
620              "is_gift": {
621                "type": "boolean",
622                "description": "Indicates whether the product can be considered as a gift."
623              },
624              "is_cod": {
625                "type": "boolean",
626                "description": "Indicates whether the product is eligible for cash on delivery (COD)."
627              },
628              "is_dependent": {
629                "type": "boolean",
630                "description": "Indicates whether the product depends on another product."
631              },
632              "is_available": {
633                "type": "boolean",
634                "description": "Indicates whether the product is currently available for purchase."
635              },
636              "moq": {
637                "description": "The order quantity details required to purchase the product.",
638                "properties": {
639                  "increment_unit": {
640                    "default": 1,
641                    "description": "The minimum quantity increment in which the item can be purchased.",
642                    "minimum": 1,
643                    "type": "integer"
644                  },
645                  "maximum": {
646                    "description": "The maximum quantity allowed for purchase.",
647                    "type": "integer"
648                  },
649                  "minimum": {
650                    "default": 1,
651                    "description": "The minimum quantity required for purchase.",
652                    "minimum": 1,
653                    "type": "integer"
654                  }
655                },
656                "type": "object"
657              },
658              "seo": {
659                "description": "The SEO details related to the product, including metadata for search engine optimization.",
660                "properties": {
661                  "description": {
662                    "description": "The SEO description of the item",
663                    "type": "string"
664                  },
665                  "title": {
666                    "description": "The SEO title of the item",
667                    "type": "string"
668                  },
669                  "sitemap": {
670                    "type": "object",
671                    "properties": {
672                      "priority": {
673                        "type": "number",
674                        "description": "The SEO priority of the item"
675                      },
676                      "frequency": {
677                        "type": "string",
678                        "description": "The SEO frequency of the item"
679                      }
680                    },
681                    "required": [
682                      "priority",
683                      "frequency"
684                    ]
685                  },
686                  "breadcrumbs": {
687                    "type": "array",
688                    "items": {
689                      "properties": {
690                        "url": {
691                          "type": "string"
692                        },
693                        "action": {
694                          "properties": {
695                            "page": {
696                              "type": "object",
697                              "additionalProperties": true
698                            },
699                            "type": {
700                              "type": "string"
701                            }
702                          },
703                          "type": "object",
704                          "required": [
705                            "type"
706                          ]
707                        }
708                      },
709                      "type": "object"
710                    }
711                  },
712                  "meta_tags": {
713                    "type": "array",
714                    "items": {
715                      "properties": {
716                        "title": {
717                          "type": "string"
718                        },
719                        "items": {
720                          "items": {
721                            "properties": {
722                              "key": {
723                                "type": "string"
724                              },
725                              "value": {
726                                "type": "string"
727                              }
728                            },
729                            "type": "object",
730                            "required": [
731                              "key",
732                              "value"
733                            ]
734                          },
735                          "type": "array"
736                        }
737                      },
738                      "type": "object",
739                      "required": [
740                        "title"
741                      ]
742                    }
743                  },
744                  "canonical_url": {
745                    "type": "string"
746                  }
747                },
748                "type": "object"
749              },
750              "variants": {
751                "type": "object",
752                "additionalProperties": true,
753                "description": "An object containing details about the product variants."
754              },
755              "variant_media": {
756                "type": "object",
757                "additionalProperties": true,
758                "description": "Media items specific to the product variants."
759              },
760              "variant_group": {
761                "type": "object",
762                "additionalProperties": true,
763                "description": "A group identifier for products that are variants of one another."
764              },
765              "multi_categories": {
766                "type": "array",
767                "items": {
768                  "description": "An object representing the categories that the product belongs to.",
769                  "properties": {
770                    "l1": {
771                      "type": "integer",
772                      "description": "The ID of the Level 1 (L1) category of the product."
773                    },
774                    "l2": {
775                      "type": "integer",
776                      "description": "The ID of the Level 2 (L2) category of the product."
777                    },
778                    "l3": {
779                      "type": "integer",
780                      "description": "The ID of the Level 3 (L3) category of the product."
781                    },
782                    "is_active": {
783                      "type": "boolean",
784                      "description": "Indicates whether the L3 category of the product is currently active."
785                    },
786                    "department": {
787                      "type": "integer",
788                      "description": "The department associated with the L3 category of the product."
789                    }
790                  },
791                  "type": "object"
792                }
793              },
794              "template_tag": {
795                "type": "string",
796                "description": "Tag used for categorizing or templating purposes."
797              },
798              "net_quantity": {
799                "description": "Net quantity details for the product, specifying the amount or count  of the product included in a package. This is used in product catalogs  to convey clear and standardized information to customers.",
800                "type": "object",
801                "properties": {
802                  "unit": {
803                    "type": "string",
804                    "enum": [
805                      "L",
806                      "cm",
807                      "g",
808                      "kg",
809                      "m",
810                      "ml",
811                      "nos",
812                      "pack"
813                    ],
814                    "description": "Specifies the unit of measurement for the net quantity."
815                  },
816                  "value": {
817                    "type": "number",
818                    "description": "The numerical value representing the net quantity of the product."
819                  }
820                }
821              },
822              "custom_order": {
823                "description": "Custom order details for the product.",
824                "type": "object",
825                "properties": {
826                  "manufacturing_time_unit": {
827                    "type": "string",
828                    "description": "Unit of time for manufacturing (e.g., days, weeks)."
829                  },
830                  "is_custom_order": {
831                    "type": "boolean",
832                    "description": "Indicates if the product is available for custom orders."
833                  },
834                  "manufacturing_time": {
835                    "type": "integer",
836                    "description": "Time required for manufacturing in the specified unit."
837                  }
838                },
839                "required": [
840                  "is_custom_order"
841                ]
842              },
843              "country_of_origin": {
844                "type": "string",
845                "description": "Country where the product is manufactured or sourced from."
846              },
847              "_custom_json": {
848                "type": "object",
849                "additionalProperties": true,
850                "description": "Custom JSON data associated with the product."
851              },
852              "identifiers": {
853                "type": "array",
854                "items": {
855                  "type": "string"
856                },
857                "description": "Identifiers associated with the product."
858              },
859              "item_id": {
860                "type": "integer",
861                "description": "Unique identifier for the item."
862              },
863              "_custom_meta": {
864                "description": "Custom meta associated with the product.",
865                "type": "array",
866                "items": {
867                  "description": "Custom metadata associated with the product.",
868                  "type": "object",
869                  "properties": {
870                    "key": {
871                      "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",
872                      "type": "string",
873                      "minLength": 1,
874                      "maxLength": 30
875                    },
876                    "value": {
877                      "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",
878                      "type": "string",
879                      "minLength": 1,
880                      "maxLength": 100
881                    }
882                  },
883                  "required": [
884                    "key",
885                    "value"
886                  ]
887                }
888              },
889              "discount_percentage": {
890                "type": "integer",
891                "description": "The discount applied to the product in percentage."
892              },
893              "no_of_boxes": {
894                "type": "integer",
895                "description": "Number of boxes containing the product."
896              },
897              "created_on": {
898                "type": "string",
899                "format": "date-time",
900                "description": "The date and time when the product was created"
901              },
902              "modified_on": {
903                "type": "string",
904                "format": "date-time",
905                "description": "The date and time when the product was last modified"
906              }
907            },
908            "required": [
909              "name",
910              "is_dependent",
911              "uid",
912              "category_uid",
913              "item_code",
914              "multi_size",
915              "brand_uid",
916              "country_of_origin",
917              "item_type",
918              "departments",
919              "slug",
920              "image_nature",
921              "moq",
922              "seo",
923              "is_cod",
924              "is_gift",
925              "is_available",
926              "l3_categories"
927            ]
928          }
929        }
930      }
931    }
932  }
933}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.8d2c94ac-f669-11ee-b89c-be76afdff661"
5    ],
6    "name": "product",
7    "type": "create",
8    "version": "2",
9    "created_timestamp": 1712664369557,
10    "id": "Dd4w9m6Jjq/F+h8iPpU9eThArhRJAkH9uD2y+CMDWhU=",
11    "category": "application"
12  },
13  "company_id": 27070,
14  "application_id": [
15    "66152d7fae3ebc4cbd68841c",
16    "*"
17  ],
18  "contains": [
19    "product"
20  ],
21  "payload": {
22    "product": [
23      {
24        "uid": 7500005,
25        "popularity": 810,
26        "brand_uid": 6,
27        "category_uid": 6,
28        "discount": "10% OFF",
29        "discount_percentage": 10,
30        "slug": "product-7500005",
31        "item_code": "P",
32        "net_quantity": {},
33        "short_description": "sh",
34        "product_online_date": "2024-08-10T07:16:54.345000",
35        "verification_status": "pending",
36        "description": "main product",
37        "channel_identifier": "66b63fb59376243ba8e03696",
38        "category_slug": "tanya809142099720242142210",
39        "size_guide": "",
40        "image_nature": "standard",
41        "created_on": "2024-08-09T16:32:03.102000",
42        "modified_on": "2024-08-10T07:17:41.073000",
43        "name": "product",
44        "item_type": "standard",
45        "country_of_origin": "India",
46        "variant_media": {
47          "murray166999799720242142542": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/Q2G4ir7cX-Swatch-url.png"
48        },
49        "custom_order": {
50          "manufacturing_time_unit": "days",
51          "is_custom_order": false,
52          "manufacturing_time": 0
53        },
54        "attributes": {
55          "product_details": "<p>main product</p>",
56          "short_description": "sh",
57          "brand_name": "Darrick604828449720242141375"
58        },
59        "variant_group": {
60          "murray166999799720242142542": "tanya809142099720242142210-65086549-65634443"
61        },
62        "moq": {
63          "minimum": 1,
64          "increment_unit": 1
65        },
66        "seo": {
67          "title": "product",
68          "description": "sh"
69        },
70        "l3_categories": [
71          6
72        ],
73        "store_ids": [
74          3
75        ],
76        "company_ids": [
77          3
78        ],
79        "departments": [
80          2
81        ],
82        "tags": [],
83        "l3_category_names": [
84          "Tanya809142099720242142210"
85        ],
86        "sizes": [
87          "OS"
88        ],
89        "variants": {
90          "murray166999799720242142542": [
91            "product-myah942395149720242141753-7500001",
92            "product3-7500003",
93            "product4-7500004"
94          ]
95        },
96        "medias": [
97          {
98            "type": "image",
99            "url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/5VSjZv8NH-product.png",
100            "alt": ""
101          }
102        ],
103        "identifiers": [
104          "JKWWKJWE"
105        ],
106        "multi_categories": [
107          {
108            "l2": 5,
109            "l3": 6,
110            "l1": 4,
111            "is_active": true,
112            "department": 2
113          }
114        ],
115        "product_group_tag": [],
116        "highlights": [],
117        "is_available": true,
118        "multi_size": true,
119        "is_dependent": false,
120        "is_gift": false,
121        "is_cod": true,
122        "_custom_json": {},
123        "_custom_meta": [],
124        "teaser_tag": "Fynd Assured|",
125        "price": {
126          "marked": {
127            "min": 1000,
128            "max": 1000,
129            "currency_code": "INR",
130            "currency_symbol": "₹"
131          },
132          "effective": {
133            "min": 900,
134            "max": 900,
135            "currency_code": "INR",
136            "currency_symbol": "₹"
137          },
138          "selling": {
139            "min": 900,
140            "max": 900,
141            "currency_code": "INR",
142            "currency_symbol": "₹"
143          }
144        }
145      }
146    ]
147  }
148}

application/product/delete/v2

this event is triggered when product 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
product
array of object
Required
Array of Properties
item_id
integer
Required
uid
integer
Required
company_id
integer
Required
brand_uid
integer
Required
item_code
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        "product"
78      ],
79      "properties": {
80        "product": {
81          "type": "array",
82          "items": {
83            "type": "object",
84            "required": [
85              "item_id",
86              "company_id",
87              "brand_uid",
88              "item_code",
89              "uid"
90            ],
91            "properties": {
92              "item_id": {
93                "type": "integer"
94              },
95              "uid": {
96                "type": "integer"
97              },
98              "company_id": {
99                "type": "integer"
100              },
101              "brand_uid": {
102                "type": "integer"
103              },
104              "item_code": {
105                "type": "string"
106              }
107            }
108          }
109        }
110      }
111    }
112  }
113}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.e2a8d1a6-f660-11ee-b7a5-8edd95bdefe0"
5    ],
6    "name": "product",
7    "type": "delete",
8    "version": "2",
9    "created_timestamp": 1712660647507,
10    "id": "lRlSMKsMiPDJeGTD3I+qQy0HlB5ahVEnD/G/PInOs5I=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 1,
15  "application_id": [
16    "000000000000000000000001",
17    "*"
18  ],
19  "contains": [
20    "product"
21  ],
22  "payload": {
23    "product": [
24      {
25        "item_id": 7648605,
26        "company_id": 1,
27        "brand_uid": 65221,
28        "item_code": "DKJ789324789",
29        "uid": 7648605
30      }
31    ]
32  }
33}

application/product/update/v2

this event is triggered when product 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
product
array of object
Array of Properties
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object
The brand associated with the product.
Properties
action
object
Schema to define the Action Object
Properties
type
string
Type of action to be taken e.g, page.
page
object
Represents the page details used for rendering.
Properties
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
string
Required
The type of action such as product, products, category, brand.
Enum
popup
object
Represents the page details used for rendering.
Properties
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
string
Required
The type of action such as product, products, category, brand.
Enum
logo
object
Media information about the product, including metadata, type, URL, and alternative text.
Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
Required
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
Required
A unique code assigned to the product item at company and brand level.
item_type
string
Required
The type of the product, defining its nature.
Enum
medias
array of object
A list of media items associated with the product, such as images or videos.
Array of Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Required
The name of the product.
price
Undefined Type
The pricing details of the product.
Properties
effective
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
Required
A URL-friendly string representing the product.
teaser_tag
string
A teaser tag string providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
Required
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
Required
The unique identifier for the brand associated with the product.
category_uid
integer
Required
The unique identifier for the category to which the product belongs.
verification_status
string
Verification status of the product.
Enum
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
Required
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
Required
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Required
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Required
Indicates whether the product can be considered as a gift.
is_cod
boolean
Required
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Required
Indicates whether the product depends on another product.
is_available
boolean
Required
Indicates whether the product is currently available for purchase.
moq
object
Required
The order quantity details required to purchase the product.
Properties
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object
Required
The SEO details related to the product, including metadata for search engine optimization.
Properties
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object
Properties
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object
Array of Properties
url
string
action
object
Properties
page
object
type
string
Required
meta_tags
array of object
Array of Properties
title
string
Required
items
array of object
Array of Properties
key
string
Required
value
string
Required
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object
Array of Properties
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
Enum
value
number
The numerical value representing the net quantity of the product.
custom_order
object
Custom order details for the product.
Properties
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Required
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object
Custom meta associated with the product.
Array of Properties
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
no_of_boxes
integer
Number of boxes containing the product.
created_on
string
| date-time
The date and time when the product was created
modified_on
string
| date-time
The date and time when the product was last modified
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      "properties": {
77        "product": {
78          "type": "array",
79          "items": {
80            "type": "object",
81            "properties": {
82              "attributes": {
83                "type": "object",
84                "additionalProperties": true,
85                "description": "Additional attributes of the product, such as custom properties or features."
86              },
87              "brand": {
88                "properties": {
89                  "action": {
90                    "type": "object",
91                    "description": "Schema to define the Action Object",
92                    "properties": {
93                      "type": {
94                        "type": "string",
95                        "description": "Type of action to be taken e.g, page.",
96                        "example": "test"
97                      },
98                      "page": {
99                        "type": "object",
100                        "description": "Represents the page details used for rendering.",
101                        "required": [
102                          "type"
103                        ],
104                        "properties": {
105                          "params": {
106                            "type": "object",
107                            "description": "Parameters that should be considered in path.",
108                            "additionalProperties": {
109                              "type": "array",
110                              "items": {
111                                "type": "string",
112                                "description": "A string parameter for the action."
113                              }
114                            }
115                          },
116                          "query": {
117                            "type": "object",
118                            "description": "Query parameter if any to be added to the action.",
119                            "additionalProperties": {
120                              "type": "array",
121                              "items": {
122                                "type": "string",
123                                "description": "A string query parameter for the action."
124                              }
125                            }
126                          },
127                          "url": {
128                            "type": "string",
129                            "description": "The URL for the action."
130                          },
131                          "type": {
132                            "type": "string",
133                            "description": "The type of action such as product, products, category, brand.",
134                            "enum": [
135                              "about-us",
136                              "addresses",
137                              "blog",
138                              "brands",
139                              "cards",
140                              "cart",
141                              "categories",
142                              "brand",
143                              "category",
144                              "collection",
145                              "collections",
146                              "custom",
147                              "contact-us",
148                              "external",
149                              "faq",
150                              "freshchat",
151                              "home",
152                              "notification-settings",
153                              "orders",
154                              "page",
155                              "policy",
156                              "product",
157                              "product-request",
158                              "products",
159                              "profile",
160                              "profile-order-shipment",
161                              "profile-basic",
162                              "profile-company",
163                              "profile-emails",
164                              "profile-phones",
165                              "rate-us",
166                              "refer-earn",
167                              "settings",
168                              "shared-cart",
169                              "tnc",
170                              "track-order",
171                              "wishlist",
172                              "sections",
173                              "form",
174                              "cart-delivery",
175                              "cart-payment",
176                              "cart-review",
177                              "login",
178                              "register",
179                              "shipping-policy",
180                              "return-policy",
181                              "order-status",
182                              "locate-us"
183                            ]
184                          }
185                        }
186                      },
187                      "popup": {
188                        "type": "object",
189                        "description": "Represents the page details used for rendering.",
190                        "required": [
191                          "type"
192                        ],
193                        "properties": {
194                          "params": {
195                            "type": "object",
196                            "description": "Parameters that should be considered in path.",
197                            "additionalProperties": {
198                              "type": "array",
199                              "items": {
200                                "type": "string",
201                                "description": "A string parameter for the action."
202                              }
203                            }
204                          },
205                          "query": {
206                            "type": "object",
207                            "description": "Query parameter if any to be added to the action.",
208                            "additionalProperties": {
209                              "type": "array",
210                              "items": {
211                                "type": "string",
212                                "description": "A string query parameter for the action."
213                              }
214                            }
215                          },
216                          "url": {
217                            "type": "string",
218                            "description": "The URL for the action."
219                          },
220                          "type": {
221                            "type": "string",
222                            "description": "The type of action such as product, products, category, brand.",
223                            "enum": [
224                              "about-us",
225                              "addresses",
226                              "blog",
227                              "brands",
228                              "cards",
229                              "cart",
230                              "categories",
231                              "brand",
232                              "category",
233                              "collection",
234                              "collections",
235                              "custom",
236                              "contact-us",
237                              "external",
238                              "faq",
239                              "freshchat",
240                              "home",
241                              "notification-settings",
242                              "orders",
243                              "page",
244                              "policy",
245                              "product",
246                              "product-request",
247                              "products",
248                              "profile",
249                              "profile-order-shipment",
250                              "profile-basic",
251                              "profile-company",
252                              "profile-emails",
253                              "profile-phones",
254                              "rate-us",
255                              "refer-earn",
256                              "settings",
257                              "shared-cart",
258                              "tnc",
259                              "track-order",
260                              "wishlist",
261                              "sections",
262                              "form",
263                              "cart-delivery",
264                              "cart-payment",
265                              "cart-review",
266                              "login",
267                              "register",
268                              "shipping-policy",
269                              "return-policy",
270                              "order-status",
271                              "locate-us"
272                            ]
273                          }
274                        }
275                      }
276                    }
277                  },
278                  "logo": {
279                    "description": "Media information about the product, including metadata, type, URL, and alternative text.",
280                    "properties": {
281                      "meta": {
282                        "type": "object",
283                        "additionalProperties": true,
284                        "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."
285                      },
286                      "type": {
287                        "type": "string",
288                        "enum": [
289                          "image",
290                          "video",
291                          "3d_model"
292                        ],
293                        "description": "The type of media."
294                      },
295                      "url": {
296                        "type": "string",
297                        "description": "The URL where the media can be accessed."
298                      },
299                      "alt": {
300                        "type": "string",
301                        "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
302                      },
303                      "thumbnail": {
304                        "type": "string",
305                        "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
306                      }
307                    },
308                    "required": [
309                      "url"
310                    ],
311                    "type": "object"
312                  },
313                  "name": {
314                    "type": "string"
315                  },
316                  "uid": {
317                    "type": "integer"
318                  }
319                },
320                "type": "object",
321                "description": "The brand associated with the product."
322              },
323              "description": {
324                "type": "string",
325                "description": "A detailed description of the product."
326              },
327              "discount": {
328                "type": "string",
329                "description": "The discount applied to the product."
330              },
331              "has_variant": {
332                "type": "boolean",
333                "description": "Indicates whether the product has variants, such as different sizes or colors."
334              },
335              "highlights": {
336                "items": {
337                  "type": "string"
338                },
339                "type": "array",
340                "description": "Key highlights of the product."
341              },
342              "image_nature": {
343                "type": "string",
344                "enum": [
345                  "default",
346                  "standard"
347                ],
348                "description": "The nature of the product image, indicating if it's the default or a standard image."
349              },
350              "item_code": {
351                "type": "string",
352                "x-not-enum": true,
353                "description": "A unique code assigned to the product item at company and brand level."
354              },
355              "item_type": {
356                "type": "string",
357                "enum": [
358                  "composite",
359                  "digital",
360                  "packaging",
361                  "set",
362                  "standard"
363                ],
364                "description": "The type of the product, defining its nature."
365              },
366              "medias": {
367                "items": {
368                  "description": "Media information about the product, including metadata, type, URL, and alternative text.",
369                  "properties": {
370                    "meta": {
371                      "type": "object",
372                      "additionalProperties": true,
373                      "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."
374                    },
375                    "type": {
376                      "type": "string",
377                      "enum": [
378                        "image",
379                        "video",
380                        "3d_model"
381                      ],
382                      "description": "The type of media."
383                    },
384                    "url": {
385                      "type": "string",
386                      "description": "The URL where the media can be accessed."
387                    },
388                    "alt": {
389                      "type": "string",
390                      "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."
391                    },
392                    "thumbnail": {
393                      "type": "string",
394                      "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."
395                    }
396                  },
397                  "required": [
398                    "url"
399                  ],
400                  "type": "object"
401                },
402                "type": "array",
403                "description": "A list of media items associated with the product, such as images or videos."
404              },
405              "name": {
406                "type": "string",
407                "description": "The name of the product."
408              },
409              "price": {
410                "description": "The pricing details of the product.",
411                "properties": {
412                  "effective": {
413                    "properties": {
414                      "currency_code": {
415                        "type": "string",
416                        "description": "ISO 4217 currency codes",
417                        "x-not-enum": true
418                      },
419                      "currency_symbol": {
420                        "type": "string"
421                      },
422                      "max": {
423                        "type": "number"
424                      },
425                      "min": {
426                        "type": "number"
427                      }
428                    },
429                    "type": "object"
430                  },
431                  "marked": {
432                    "properties": {
433                      "currency_code": {
434                        "type": "string",
435                        "description": "ISO 4217 currency codes",
436                        "x-not-enum": true
437                      },
438                      "currency_symbol": {
439                        "type": "string"
440                      },
441                      "max": {
442                        "type": "number"
443                      },
444                      "min": {
445                        "type": "number"
446                      }
447                    },
448                    "type": "object"
449                  },
450                  "selling": {
451                    "properties": {
452                      "currency_code": {
453                        "type": "string",
454                        "description": "ISO 4217 currency codes",
455                        "x-not-enum": true
456                      },
457                      "currency_symbol": {
458                        "type": "string"
459                      },
460                      "max": {
461                        "type": "number"
462                      },
463                      "min": {
464                        "type": "number"
465                      }
466                    },
467                    "type": "object"
468                  }
469                }
470              },
471              "product_online_date": {
472                "format": "date-time",
473                "type": "string",
474                "description": "The date and time when the product becomes available online."
475              },
476              "promo_meta": {
477                "type": "object",
478                "additionalProperties": true,
479                "description": "Metadata related to any promotions associated with the product."
480              },
481              "rating": {
482                "type": "number",
483                "description": "The average rating of the product, typically based on customer reviews."
484              },
485              "rating_count": {
486                "type": "integer",
487                "description": "The total number of ratings the product has received."
488              },
489              "sellable": {
490                "type": "boolean",
491                "description": "Indicates whether the product is available for sale."
492              },
493              "short_description": {
494                "type": "string",
495                "description": "A brief description of the product."
496              },
497              "similars": {
498                "items": {
499                  "type": "string"
500                },
501                "type": "array",
502                "description": "A list of similar products."
503              },
504              "slug": {
505                "type": "string",
506                "description": "A URL-friendly string representing the product."
507              },
508              "teaser_tag": {
509                "type": "string",
510                "description": "A teaser tag string providing short promotional information about the product."
511              },
512              "tryouts": {
513                "items": {
514                  "type": "string"
515                },
516                "type": "array",
517                "description": "A list of tryout options or samples available for the product."
518              },
519              "type": {
520                "type": "string",
521                "description": "The type or category of the product."
522              },
523              "uid": {
524                "type": "integer",
525                "description": "A unique identifier for the product."
526              },
527              "popularity": {
528                "type": "integer",
529                "description": "A numerical value indicating the popularity of the product."
530              },
531              "brand_uid": {
532                "type": "integer",
533                "description": "The unique identifier for the brand associated with the product."
534              },
535              "category_uid": {
536                "type": "integer",
537                "description": "The unique identifier for the category to which the product belongs."
538              },
539              "verification_status": {
540                "type": "string",
541                "enum": [
542                  "pending",
543                  "verified",
544                  "rejected"
545                ],
546                "description": "Verification status of the product."
547              },
548              "channel_identifier": {
549                "type": "string",
550                "description": "The identifier for the sales channel through which the product is sold."
551              },
552              "category_slug": {
553                "type": "string",
554                "description": "A URL-friendly string representing the product's category."
555              },
556              "size_guide": {
557                "type": "string",
558                "description": "A guide or chart providing size information for the product."
559              },
560              "l3_categories": {
561                "type": "array",
562                "items": {
563                  "type": "integer"
564                },
565                "description": "A list of L3 category IDs of the product."
566              },
567              "store_ids": {
568                "type": "array",
569                "items": {
570                  "type": "integer"
571                },
572                "description": "A list of store IDs where the product is available."
573              },
574              "company_ids": {
575                "type": "array",
576                "items": {
577                  "type": "integer"
578                },
579                "description": "A list of company IDs associated with the product."
580              },
581              "departments": {
582                "type": "array",
583                "items": {
584                  "type": "integer"
585                },
586                "description": "A list of department IDs where the product is categorized."
587              },
588              "tags": {
589                "type": "array",
590                "items": {
591                  "type": "string"
592                },
593                "description": "A list of tags or keywords associated with the product."
594              },
595              "l3_category_names": {
596                "type": "array",
597                "items": {
598                  "type": "string"
599                },
600                "description": "A list of names of L3 categories of the product."
601              },
602              "sizes": {
603                "type": "array",
604                "items": {
605                  "type": "string"
606                },
607                "description": "A list of available sizes for the product."
608              },
609              "product_group_tag": {
610                "type": "array",
611                "items": {
612                  "type": "string"
613                },
614                "description": "Tags that group the product with other similar products."
615              },
616              "multi_size": {
617                "type": "boolean",
618                "description": "Indicates whether the product is available in multiple sizes."
619              },
620              "is_gift": {
621                "type": "boolean",
622                "description": "Indicates whether the product can be considered as a gift."
623              },
624              "is_cod": {
625                "type": "boolean",
626                "description": "Indicates whether the product is eligible for cash on delivery (COD)."
627              },
628              "is_dependent": {
629                "type": "boolean",
630                "description": "Indicates whether the product depends on another product."
631              },
632              "is_available": {
633                "type": "boolean",
634                "description": "Indicates whether the product is currently available for purchase."
635              },
636              "moq": {
637                "description": "The order quantity details required to purchase the product.",
638                "properties": {
639                  "increment_unit": {
640                    "default": 1,
641                    "description": "The minimum quantity increment in which the item can be purchased.",
642                    "minimum": 1,
643                    "type": "integer"
644                  },
645                  "maximum": {
646                    "description": "The maximum quantity allowed for purchase.",
647                    "type": "integer"
648                  },
649                  "minimum": {
650                    "default": 1,
651                    "description": "The minimum quantity required for purchase.",
652                    "minimum": 1,
653                    "type": "integer"
654                  }
655                },
656                "type": "object"
657              },
658              "seo": {
659                "description": "The SEO details related to the product, including metadata for search engine optimization.",
660                "properties": {
661                  "description": {
662                    "description": "The SEO description of the item",
663                    "type": "string"
664                  },
665                  "title": {
666                    "description": "The SEO title of the item",
667                    "type": "string"
668                  },
669                  "sitemap": {
670                    "type": "object",
671                    "properties": {
672                      "priority": {
673                        "type": "number",
674                        "description": "The SEO priority of the item"
675                      },
676                      "frequency": {
677                        "type": "string",
678                        "description": "The SEO frequency of the item"
679                      }
680                    },
681                    "required": [
682                      "priority",
683                      "frequency"
684                    ]
685                  },
686                  "breadcrumbs": {
687                    "type": "array",
688                    "items": {
689                      "properties": {
690                        "url": {
691                          "type": "string"
692                        },
693                        "action": {
694                          "properties": {
695                            "page": {
696                              "type": "object",
697                              "additionalProperties": true
698                            },
699                            "type": {
700                              "type": "string"
701                            }
702                          },
703                          "type": "object",
704                          "required": [
705                            "type"
706                          ]
707                        }
708                      },
709                      "type": "object"
710                    }
711                  },
712                  "meta_tags": {
713                    "type": "array",
714                    "items": {
715                      "properties": {
716                        "title": {
717                          "type": "string"
718                        },
719                        "items": {
720                          "items": {
721                            "properties": {
722                              "key": {
723                                "type": "string"
724                              },
725                              "value": {
726                                "type": "string"
727                              }
728                            },
729                            "type": "object",
730                            "required": [
731                              "key",
732                              "value"
733                            ]
734                          },
735                          "type": "array"
736                        }
737                      },
738                      "type": "object",
739                      "required": [
740                        "title"
741                      ]
742                    }
743                  },
744                  "canonical_url": {
745                    "type": "string"
746                  }
747                },
748                "type": "object"
749              },
750              "variants": {
751                "type": "object",
752                "additionalProperties": true,
753                "description": "An object containing details about the product variants."
754              },
755              "variant_media": {
756                "type": "object",
757                "additionalProperties": true,
758                "description": "Media items specific to the product variants."
759              },
760              "variant_group": {
761                "type": "object",
762                "additionalProperties": true,
763                "description": "A group identifier for products that are variants of one another."
764              },
765              "multi_categories": {
766                "type": "array",
767                "items": {
768                  "description": "An object representing the categories that the product belongs to.",
769                  "properties": {
770                    "l1": {
771                      "type": "integer",
772                      "description": "The ID of the Level 1 (L1) category of the product."
773                    },
774                    "l2": {
775                      "type": "integer",
776                      "description": "The ID of the Level 2 (L2) category of the product."
777                    },
778                    "l3": {
779                      "type": "integer",
780                      "description": "The ID of the Level 3 (L3) category of the product."
781                    },
782                    "is_active": {
783                      "type": "boolean",
784                      "description": "Indicates whether the L3 category of the product is currently active."
785                    },
786                    "department": {
787                      "type": "integer",
788                      "description": "The department associated with the L3 category of the product."
789                    }
790                  },
791                  "type": "object"
792                }
793              },
794              "template_tag": {
795                "type": "string",
796                "description": "Tag used for categorizing or templating purposes."
797              },
798              "net_quantity": {
799                "description": "Net quantity details for the product, specifying the amount or count  of the product included in a package. This is used in product catalogs  to convey clear and standardized information to customers.",
800                "type": "object",
801                "properties": {
802                  "unit": {
803                    "type": "string",
804                    "enum": [
805                      "L",
806                      "cm",
807                      "g",
808                      "kg",
809                      "m",
810                      "ml",
811                      "nos",
812                      "pack"
813                    ],
814                    "description": "Specifies the unit of measurement for the net quantity."
815                  },
816                  "value": {
817                    "type": "number",
818                    "description": "The numerical value representing the net quantity of the product."
819                  }
820                }
821              },
822              "custom_order": {
823                "description": "Custom order details for the product.",
824                "type": "object",
825                "properties": {
826                  "manufacturing_time_unit": {
827                    "type": "string",
828                    "description": "Unit of time for manufacturing (e.g., days, weeks)."
829                  },
830                  "is_custom_order": {
831                    "type": "boolean",
832                    "description": "Indicates if the product is available for custom orders."
833                  },
834                  "manufacturing_time": {
835                    "type": "integer",
836                    "description": "Time required for manufacturing in the specified unit."
837                  }
838                },
839                "required": [
840                  "is_custom_order"
841                ]
842              },
843              "country_of_origin": {
844                "type": "string",
845                "description": "Country where the product is manufactured or sourced from."
846              },
847              "_custom_json": {
848                "type": "object",
849                "additionalProperties": true,
850                "description": "Custom JSON data associated with the product."
851              },
852              "identifiers": {
853                "type": "array",
854                "items": {
855                  "type": "string"
856                },
857                "description": "Identifiers associated with the product."
858              },
859              "item_id": {
860                "type": "integer",
861                "description": "Unique identifier for the item."
862              },
863              "_custom_meta": {
864                "description": "Custom meta associated with the product.",
865                "type": "array",
866                "items": {
867                  "description": "Custom metadata associated with the product.",
868                  "type": "object",
869                  "properties": {
870                    "key": {
871                      "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",
872                      "type": "string",
873                      "minLength": 1,
874                      "maxLength": 30
875                    },
876                    "value": {
877                      "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",
878                      "type": "string",
879                      "minLength": 1,
880                      "maxLength": 100
881                    }
882                  },
883                  "required": [
884                    "key",
885                    "value"
886                  ]
887                }
888              },
889              "discount_percentage": {
890                "type": "integer",
891                "description": "The discount applied to the product in percentage."
892              },
893              "no_of_boxes": {
894                "type": "integer",
895                "description": "Number of boxes containing the product."
896              },
897              "created_on": {
898                "type": "string",
899                "format": "date-time",
900                "description": "The date and time when the product was created"
901              },
902              "modified_on": {
903                "type": "string",
904                "format": "date-time",
905                "description": "The date and time when the product was last modified"
906              }
907            },
908            "required": [
909              "name",
910              "is_dependent",
911              "uid",
912              "category_uid",
913              "item_code",
914              "multi_size",
915              "brand_uid",
916              "country_of_origin",
917              "item_type",
918              "departments",
919              "slug",
920              "image_nature",
921              "moq",
922              "seo",
923              "is_cod",
924              "is_gift",
925              "is_available",
926              "l3_categories"
927            ]
928          }
929        }
930      }
931    }
932  }
933}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "wildrider.8d2c94ac-f669-11ee-b89c-be76afdff661"
5    ],
6    "name": "product",
7    "type": "update",
8    "version": "2",
9    "created_timestamp": 1712664369557,
10    "id": "Dd4w9m6Jjq/F+h8iPpU9eThArhRJAkH9uD2y+CMDWhU=",
11    "category": "application"
12  },
13  "company_id": 27070,
14  "application_id": [
15    "66152d7fae3ebc4cbd68841c",
16    "*"
17  ],
18  "contains": [
19    "product"
20  ],
21  "payload": {
22    "product": [
23      {
24        "uid": 7500005,
25        "popularity": 810,
26        "brand_uid": 6,
27        "category_uid": 6,
28        "discount": "10% OFF",
29        "discount_percentage": 10,
30        "slug": "product-7500005",
31        "item_code": "P",
32        "net_quantity": {},
33        "short_description": "sh",
34        "product_online_date": "2024-08-10T07:16:54.345000",
35        "verification_status": "pending",
36        "description": "main product",
37        "channel_identifier": "66b63fb59376243ba8e03696",
38        "category_slug": "tanya809142099720242142210",
39        "size_guide": "",
40        "image_nature": "standard",
41        "created_on": "2024-08-09T16:32:03.102000",
42        "modified_on": "2024-08-10T07:17:41.073000",
43        "name": "product",
44        "item_type": "standard",
45        "country_of_origin": "India",
46        "variant_media": {
47          "murray166999799720242142542": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/Q2G4ir7cX-Swatch-url.png"
48        },
49        "custom_order": {
50          "manufacturing_time_unit": "days",
51          "is_custom_order": false,
52          "manufacturing_time": 0
53        },
54        "attributes": {
55          "product_details": "<p>main product</p>",
56          "short_description": "sh",
57          "brand_name": "Darrick604828449720242141375"
58        },
59        "variant_group": {
60          "murray166999799720242142542": "tanya809142099720242142210-65086549-65634443"
61        },
62        "moq": {
63          "minimum": 1,
64          "increment_unit": 1
65        },
66        "seo": {
67          "title": "product",
68          "description": "sh"
69        },
70        "l3_categories": [
71          6
72        ],
73        "store_ids": [
74          3
75        ],
76        "company_ids": [
77          3
78        ],
79        "departments": [
80          2
81        ],
82        "tags": [],
83        "l3_category_names": [
84          "Tanya809142099720242142210"
85        ],
86        "sizes": [
87          "OS"
88        ],
89        "all_sizes": [
90          "OS"
91        ],
92        "variants": {
93          "murray166999799720242142542": [
94            "product-myah942395149720242141753-7500001",
95            "product3-7500003",
96            "product4-7500004"
97          ]
98        },
99        "medias": [
100          {
101            "type": "image",
102            "url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/5VSjZv8NH-product.png",
103            "alt": ""
104          }
105        ],
106        "identifiers": [
107          "JKWWKJWE"
108        ],
109        "multi_categories": [
110          {
111            "l2": 5,
112            "l3": 6,
113            "l1": 4,
114            "is_active": true,
115            "department": 2
116          }
117        ],
118        "product_group_tag": [],
119        "highlights": [],
120        "is_available": true,
121        "multi_size": true,
122        "is_dependent": false,
123        "is_gift": false,
124        "is_cod": true,
125        "_custom_json": {},
126        "_custom_meta": [],
127        "teaser_tag": "Fynd Assured|",
128        "price": {
129          "marked": {
130            "min": 1000,
131            "max": 1000,
132            "currency_code": "INR",
133            "currency_symbol": "₹"
134          },
135          "effective": {
136            "min": 900,
137            "max": 900,
138            "currency_code": "INR",
139            "currency_symbol": "₹"
140          },
141          "selling": {
142            "min": 900,
143            "max": 900,
144            "currency_code": "INR",
145            "currency_symbol": "₹"
146          }
147        }
148      }
149    ]
150  }
151}

Promotion

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

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

application/promotion/create/v1

this event is triggered when promotion 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
promotion
object
Required
Properties
_id
string
Required
ID of the promotion
mode
string
Required
Type of promotion. Possible values: promotion, coupon
code
string
Promotion unique code
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart. False value denotes promotion creation is in progress, while True value denotes promotion has been created successfully
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
author
object
Required
Properties
created_by
string
Required
ID of the user who created the promotion
modified_by
string
Required
ID of the user who last modified the promotion
approved_by
string|null
ID of the user who approved the promotion
rejected_by
string|null
ID of the user who rejected the promotion
reviewed_by
string|null
ID of the user who reviewed the promotion
currency
string
Required
ISO code of the currency
_schedule
object
Required
Properties
status
string
Status of the promotion
Enum
end
string|null
Promotion validity end date
cron
string|null
start
string|null
Required
Promotion validity start date
duration
integer|null
Required
published
boolean
Required
If promotion is published or marked inactive
next_schedule
array of object
Required
next schedule of the promotion
Array of Properties
end
string|null
end timestamp of the promotion
start
string|null
Required
start timestamp of the promotion
buy_rules
object
Required
Rules for purchases required to apply the promotion
date_meta
object
Required
Date details of promotion
Properties
created_on
string
Required
Promotion creation ISOdate
modified_on
string
Required
Promotion last modified ISOdate
approved_on
string|null
Promotion approved ISOdate
rejected_on
string|null
Promotion rejected ISOdate
reviewed_on
string|null
Promotion reviewed on ISOdate
ownership
object
ownership details of the promotion
Properties
payable_by
string|null
Required
who pays the promotion amount
payable_category
string
Required
category of the payer amount of promotion
stackable
boolean
Required
Indicates if promotion can be applied along with another promotion
promo_group
string
Required
Promotion group. Possible values: product, cart, contract, ladder_price
visiblility
object
Required
visibility details of promotion
Properties
pdp
boolean
Required
Show promotion on PDP page
coupon_list
boolean
Required
Show promotions under coupon list. Used when promotion mode is coupon
display_meta
object
Required
display details of promotion
Properties
name
string
Required
Name of promotion on Fynd Platform Panel
offer_text
string|null
Required
Promotional offer text to be shown on PDP or Cart
description
string|null
Required
Promotion T&C description
offer_label
string
Lable of the promotion offer
restrictions
object
Required
restrictions of promotions
Properties
user_type
string
User type based restriction on the promotion
email_domain
array of
List of email domains to restrict promotion
ordering_stores
array of
List of ordering stores to restrict promotion
uses
object
Required
defines usage details of promotion
Properties
maximum
object
Required
Defines maximum usage of promotion
Properties
user
integer
Required
Maximum usage of promotion per user
total
integer
Required
Maximum total usage of promotion
remaining
object
Required
Defines total usage of promotion
Properties
user
integer
Required
Remaining usage of promotion per user
total
integer
Required
Remaining total usage of promotion
user_id
array of Undefined Type
Required
List of only allowed user _ids for whom promotion should be applicable
payments
object
Defines allowed payments for promotion, all if empty
platforms
array of Undefined Type
Required
List of device platforms on which promotion is allowed. Possible values: web, ios, android
post_order
object
Required
post order actions allowed after order created with promotion
Properties
return_allowed
boolean
Required
Indicates whether customers can return an order purchased with promotion applied
cancellation_allowed
boolean
Required
Indicates whether customers can cancel an order purchased with promotion applied
user_groups
array of Undefined Type
List of user groups for whom promotion should be applicable
anonymous_users
boolean
Allow anonymous users to avail this promotion
user_registered
object
Required
Allow promotion to be applied for users registered within specified dates
Properties
end
string|null
end date of user registration
start
string|null
start date of user registration
application_id
string
Required
ID of the application (sales channel) where promotion is applicable
apply_priority
integer
Required
Priority of applying a promotion. Higher value promotions are applied first
discount_rules
array of Undefined Type
Required
Discount rules for the promotion
promotion_type
string
Required
Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom
apply_exclusive
string|null
If allowed, any other promotion after current promotion is applied. Possible values: article, cart, null
post_order_action
object
Details of post order action for the promotion
Properties
action_date
string|null
action data to be used to perform
action_type
string|null
action type to be performed after order placed with promotion
apply_all_discount
boolean
Required
Indicates whether multiple discount rules can be applied together or not
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        "promotion"
78      ],
79      "properties": {
80        "promotion": {
81          "type": "object",
82          "required": [
83            "display_meta",
84            "apply_priority",
85            "stackable",
86            "date_meta",
87            "application_id",
88            "discount_rules",
89            "apply_all_discount",
90            "currency",
91            "_schedule",
92            "mode",
93            "restrictions",
94            "promotion_type",
95            "_id",
96            "visiblility",
97            "buy_rules",
98            "author",
99            "promo_group"
100          ],
101          "properties": {
102            "_id": {
103              "type": "string",
104              "description": "ID of the promotion"
105            },
106            "mode": {
107              "type": "string",
108              "description": "Type of promotion. Possible values: promotion, coupon"
109            },
110            "code": {
111              "type": "string",
112              "description": "Promotion unique code"
113            },
114            "is_processed": {
115              "type": "boolean",
116              "description": "Flag to verify if promotion is ready to be applied on cart. False value denotes promotion creation is in progress, while True value denotes promotion has been created successfully"
117            },
118            "calculate_on": {
119              "type": "string",
120              "description": "Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type",
121              "enum": [
122                "mrp",
123                "esp"
124              ]
125            },
126            "author": {
127              "type": "object",
128              "required": [
129                "modified_by",
130                "created_by"
131              ],
132              "properties": {
133                "created_by": {
134                  "type": "string",
135                  "description": "ID of the user who created the promotion"
136                },
137                "modified_by": {
138                  "type": "string",
139                  "description": "ID of the user who last modified the promotion"
140                },
141                "approved_by": {
142                  "type": [
143                    "string",
144                    "null"
145                  ],
146                  "description": "ID of the user who approved the promotion"
147                },
148                "rejected_by": {
149                  "type": [
150                    "string",
151                    "null"
152                  ],
153                  "description": "ID of the user who rejected the promotion"
154                },
155                "reviewed_by": {
156                  "type": [
157                    "string",
158                    "null"
159                  ],
160                  "description": "ID of the user who reviewed the promotion"
161                }
162              }
163            },
164            "currency": {
165              "type": "string",
166              "description": "ISO code of the currency"
167            },
168            "_schedule": {
169              "type": "object",
170              "required": [
171                "duration",
172                "start",
173                "next_schedule",
174                "published"
175              ],
176              "properties": {
177                "status": {
178                  "type": "string",
179                  "enum": [
180                    "draft",
181                    "review",
182                    "rejected",
183                    "approved"
184                  ],
185                  "description": "Status of the promotion"
186                },
187                "end": {
188                  "type": [
189                    "string",
190                    "null"
191                  ],
192                  "description": "Promotion validity end date"
193                },
194                "cron": {
195                  "type": [
196                    "string",
197                    "null"
198                  ]
199                },
200                "start": {
201                  "type": [
202                    "string",
203                    "null"
204                  ],
205                  "description": "Promotion validity start date"
206                },
207                "duration": {
208                  "type": [
209                    "integer",
210                    "null"
211                  ]
212                },
213                "published": {
214                  "type": "boolean",
215                  "description": "If promotion is published or marked inactive"
216                },
217                "next_schedule": {
218                  "type": "array",
219                  "description": "next schedule of the promotion",
220                  "items": {
221                    "type": "object",
222                    "required": [
223                      "start"
224                    ],
225                    "properties": {
226                      "end": {
227                        "type": [
228                          "string",
229                          "null"
230                        ],
231                        "description": "end timestamp of the promotion"
232                      },
233                      "start": {
234                        "type": [
235                          "string",
236                          "null"
237                        ],
238                        "description": "start timestamp of the promotion"
239                      }
240                    }
241                  }
242                }
243              }
244            },
245            "buy_rules": {
246              "type": "object",
247              "description": "Rules for purchases required to apply the promotion",
248              "properties": {},
249              "additionalProperties": true
250            },
251            "date_meta": {
252              "type": "object",
253              "required": [
254                "created_on",
255                "modified_on"
256              ],
257              "description": "Date details of promotion",
258              "properties": {
259                "created_on": {
260                  "type": "string",
261                  "description": "Promotion creation ISOdate"
262                },
263                "modified_on": {
264                  "type": "string",
265                  "description": "Promotion last modified ISOdate"
266                },
267                "approved_on": {
268                  "type": [
269                    "string",
270                    "null"
271                  ],
272                  "description": "Promotion approved ISOdate"
273                },
274                "rejected_on": {
275                  "type": [
276                    "string",
277                    "null"
278                  ],
279                  "description": "Promotion rejected ISOdate"
280                },
281                "reviewed_on": {
282                  "type": [
283                    "string",
284                    "null"
285                  ],
286                  "description": "Promotion reviewed on ISOdate"
287                }
288              }
289            },
290            "ownership": {
291              "type": "object",
292              "description": "ownership details of the promotion",
293              "required": [
294                "payable_by",
295                "payable_category"
296              ],
297              "properties": {
298                "payable_by": {
299                  "type": [
300                    "string",
301                    "null"
302                  ],
303                  "description": "who pays the promotion amount"
304                },
305                "payable_category": {
306                  "type": "string",
307                  "description": "category of the payer amount of promotion"
308                }
309              }
310            },
311            "stackable": {
312              "type": "boolean",
313              "description": "Indicates if promotion can be applied along with another promotion"
314            },
315            "promo_group": {
316              "type": "string",
317              "description": "Promotion group. Possible values: product, cart, contract, ladder_price"
318            },
319            "visiblility": {
320              "type": "object",
321              "required": [
322                "pdp",
323                "coupon_list"
324              ],
325              "description": "visibility details of promotion",
326              "properties": {
327                "pdp": {
328                  "type": "boolean",
329                  "description": "Show promotion on PDP page"
330                },
331                "coupon_list": {
332                  "type": "boolean",
333                  "description": "Show promotions under coupon list. Used when promotion mode is coupon"
334                }
335              }
336            },
337            "display_meta": {
338              "type": "object",
339              "required": [
340                "offer_text",
341                "description",
342                "name"
343              ],
344              "description": "display details of promotion",
345              "properties": {
346                "name": {
347                  "type": "string",
348                  "description": "Name of promotion on Fynd Platform Panel"
349                },
350                "offer_text": {
351                  "type": [
352                    "string",
353                    "null"
354                  ],
355                  "description": "Promotional offer text to be shown on PDP or Cart"
356                },
357                "description": {
358                  "type": [
359                    "string",
360                    "null"
361                  ],
362                  "description": "Promotion T&C description"
363                },
364                "offer_label": {
365                  "type": "string",
366                  "description": "Lable of the promotion offer"
367                }
368              }
369            },
370            "restrictions": {
371              "type": "object",
372              "required": [
373                "user_registered",
374                "user_id",
375                "uses",
376                "post_order",
377                "platforms"
378              ],
379              "description": "restrictions of promotions",
380              "properties": {
381                "user_type": {
382                  "type": "string",
383                  "description": "User type based restriction on the promotion"
384                },
385                "email_domain": {
386                  "type": "array",
387                  "description": "List of email domains to restrict promotion"
388                },
389                "ordering_stores": {
390                  "type": "array",
391                  "description": "List of ordering stores to restrict promotion"
392                },
393                "uses": {
394                  "type": "object",
395                  "required": [
396                    "maximum",
397                    "remaining"
398                  ],
399                  "properties": {
400                    "maximum": {
401                      "type": "object",
402                      "required": [
403                        "user",
404                        "total"
405                      ],
406                      "properties": {
407                        "user": {
408                          "type": "integer",
409                          "description": "Maximum usage of promotion per user"
410                        },
411                        "total": {
412                          "type": "integer",
413                          "description": "Maximum total usage of promotion"
414                        }
415                      },
416                      "description": "Defines maximum usage of promotion"
417                    },
418                    "remaining": {
419                      "type": "object",
420                      "required": [
421                        "user",
422                        "total"
423                      ],
424                      "properties": {
425                        "user": {
426                          "type": "integer",
427                          "description": "Remaining usage of promotion per user"
428                        },
429                        "total": {
430                          "type": "integer",
431                          "description": "Remaining total usage of promotion"
432                        }
433                      },
434                      "description": "Defines total usage of promotion"
435                    }
436                  },
437                  "description": "defines usage details of promotion"
438                },
439                "user_id": {
440                  "type": "array",
441                  "items": {},
442                  "description": "List of only allowed user _ids for whom promotion should be applicable"
443                },
444                "payments": {
445                  "type": "object",
446                  "properties": {},
447                  "additionalProperties": true,
448                  "description": "Defines allowed payments for promotion, all if empty"
449                },
450                "platforms": {
451                  "type": "array",
452                  "items": [
453                    {
454                      "type": "string"
455                    }
456                  ],
457                  "description": "List of device platforms on which promotion is allowed. Possible values: web, ios, android"
458                },
459                "post_order": {
460                  "type": "object",
461                  "required": [
462                    "cancellation_allowed",
463                    "return_allowed"
464                  ],
465                  "properties": {
466                    "return_allowed": {
467                      "type": "boolean",
468                      "description": "Indicates whether customers can return an order purchased with promotion applied"
469                    },
470                    "cancellation_allowed": {
471                      "type": "boolean",
472                      "description": "Indicates whether customers can cancel an order purchased with promotion applied"
473                    }
474                  },
475                  "description": "post order actions allowed after order created with promotion"
476                },
477                "user_groups": {
478                  "type": "array",
479                  "items": {},
480                  "description": "List of user groups for whom promotion should be applicable"
481                },
482                "anonymous_users": {
483                  "type": "boolean",
484                  "description": "Allow anonymous users to avail this promotion"
485                },
486                "user_registered": {
487                  "type": "object",
488                  "properties": {
489                    "end": {
490                      "type": [
491                        "string",
492                        "null"
493                      ],
494                      "description": "end date of user registration"
495                    },
496                    "start": {
497                      "type": [
498                        "string",
499                        "null"
500                      ],
501                      "description": "start date of user registration"
502                    }
503                  },
504                  "description": "Allow promotion to be applied for users registered within specified dates"
505                }
506              }
507            },
508            "application_id": {
509              "type": "string",
510              "description": "ID of the application (sales channel) where promotion is applicable"
511            },
512            "apply_priority": {
513              "type": "integer",
514              "description": "Priority of applying a promotion. Higher value promotions are applied first"
515            },
516            "discount_rules": {
517              "type": "array",
518              "items": [
519                {
520                  "type": "object",
521                  "required": [
522                    "item_criteria",
523                    "discount_type",
524                    "buy_condition",
525                    "offer"
526                  ],
527                  "properties": {
528                    "offer": {
529                      "type": "object",
530                      "properties": {
531                        "discount_percentage": {
532                          "type": "number",
533                          "format": "float",
534                          "description": "Percentage of the discount given"
535                        },
536                        "discount_amount": {
537                          "type": "number",
538                          "format": "float",
539                          "description": "Amount of the given discount"
540                        },
541                        "max_offer_quantity": {
542                          "type": "integer",
543                          "description": "Max  offer for the given discount"
544                        },
545                        "min_offer_quantity": {
546                          "type": "integer",
547                          "description": "Min  offer for the given discount"
548                        }
549                      },
550                      "description": "Offer given by promotion"
551                    },
552                    "buy_condition": {
553                      "type": "string",
554                      "description": "buy condition of rules for the promotion"
555                    },
556                    "discount_type": {
557                      "type": "string",
558                      "description": "type of discount by promotion"
559                    },
560                    "item_criteria": {
561                      "type": "object",
562                      "properties": {
563                        "item_store": {
564                          "type": "array",
565                          "items": {
566                            "type": "integer"
567                          },
568                          "description": "The unique identifier of the item store."
569                        },
570                        "item_id": {
571                          "type": "array",
572                          "items": {
573                            "type": "integer"
574                          },
575                          "description": "The unique identifier of the item."
576                        },
577                        "all_items": {
578                          "type": "boolean",
579                          "description": "Used for attaching all products for the promotion"
580                        },
581                        "buy_rules": {
582                          "type": "array",
583                          "description": "Rules for purchases required to apply the promotion",
584                          "items": {
585                            "type": "string"
586                          }
587                        }
588                      },
589                      "description": "item criteria that should meet to apply the promotion"
590                    }
591                  }
592                }
593              ],
594              "description": "Discount rules for the promotion"
595            },
596            "promotion_type": {
597              "type": "string",
598              "description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom"
599            },
600            "apply_exclusive": {
601              "type": [
602                "string",
603                "null"
604              ],
605              "description": "If allowed, any other promotion after current promotion is applied. Possible values: article, cart, null"
606            },
607            "post_order_action": {
608              "type": "object",
609              "properties": {
610                "action_date": {
611                  "type": [
612                    "string",
613                    "null"
614                  ],
615                  "description": "action data to be used to perform "
616                },
617                "action_type": {
618                  "type": [
619                    "string",
620                    "null"
621                  ],
622                  "description": "action type to be performed after order placed with promotion"
623                }
624              },
625              "description": "Details of post order action for the promotion"
626            },
627            "apply_all_discount": {
628              "type": "boolean",
629              "description": "Indicates whether multiple discount rules can be applied together or not"
630            }
631          }
632        }
633      }
634    }
635  }
636}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.4cf2ac22-df27-446b-9110-6b4041e3c9e8"
5    ],
6    "name": "promotion",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711966792722,
10    "id": "mfNVsudzsKMZAWTWEncsgb8dpbemcI9OkCMBzI1ECek=",
11    "category": "application"
12  },
13  "company_id": 507,
14  "application_id": "64991b4e6d274c7422bbdf7c",
15  "contains": [
16    "promotion"
17  ],
18  "payload": {
19    "promotion": {
20      "buy_rules": {
21        "rule#1": {
22          "product_tags": [
23            "B140-50"
24          ],
25          "cart_quantity": {
26            "greater_than_equals": 2
27          },
28          "item_store": [
29            18268,
30            19641,
31            19643,
32            19644
33          ],
34          "item_brand": [
35            9
36          ]
37        }
38      },
39      "discount_rules": [
40        {
41          "item_criteria": {
42            "buy_rules": [
43              "rule#1"
44            ]
45          },
46          "discount_type": "percentage",
47          "buy_condition": "( rule#1 )",
48          "offer": {
49            "discount_percentage": 16.6666666667
50          }
51        }
52      ],
53      "ownership": {
54        "payable_by": "",
55        "payable_category": "seller"
56      },
57      "currency": "INR",
58      "mode": "promotion",
59      "is_processed": false,
60      "code": "example_code",
61      "visiblility": {
62        "coupon_list": false,
63        "pdp": true
64      },
65      "apply_all_discount": false,
66      "application_id": "64991b4e6d274c7422bbdf7c",
67      "restrictions": {
68        "uses": {
69          "remaining": {
70            "total": 0,
71            "user": 0
72          },
73          "maximum": {
74            "total": 0,
75            "user": 0
76          }
77        },
78        "email_domain": [],
79        "platforms": [
80          "web",
81          "android",
82          "ios"
83        ],
84        "user_id": [],
85        "ordering_stores": [],
86        "user_groups": [],
87        "payments": {},
88        "post_order": {
89          "return_allowed": true,
90          "cancellation_allowed": true
91        },
92        "user_registered": {
93          "start": null,
94          "end": null
95        },
96        "user_type": "all_user"
97      },
98      "display_meta": {
99        "offer_text": "Buy 1 40% Buy 2 50%",
100        "name": "Buy 1 40% Buy 2 50%",
101        "description": "<p>Buy 1 40% Buy 2 50%</p>",
102        "offer_label": "Buy 1 40% Buy 2 50%"
103      },
104      "_schedule": {
105        "published": true,
106        "next_schedule": [
107          {
108            "start": "2024-04-01T10:20:24+00:00",
109            "end": "2024-04-09T18:05:00+00:00"
110          }
111        ],
112        "end": "2024-04-09T18:05:00+00:00",
113        "cron": "",
114        "start": "2024-04-01T10:20:24+00:00",
115        "duration": 0
116      },
117      "stackable": true,
118      "promotion_type": "percentage",
119      "date_meta": {
120        "created_on": "2024-04-01T10:19:52.706137+00:00",
121        "modified_on": "2024-04-01T10:19:52.706137+00:00"
122      },
123      "apply_priority": 1,
124      "promo_group": "product",
125      "apply_exclusive": null,
126      "_id": "660a8a4841b576969e21b105",
127      "calculate_on": "esp",
128      "post_order_action": {
129        "action_type": "",
130        "action_date": null
131      },
132      "author": {
133        "created_by": "cdeebdaa330629fee38306fd",
134        "modified_by": "cdeebdaa330629fee38306fd"
135      }
136    }
137  }
138}

application/promotion/update/v1

this event is triggered when promotion 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
promotion
object
Required
Properties
_id
string
Required
ID of the promotion
mode
string
Required
Type of promotion. Possible values: promotion, coupon
code
string
Promotion unique code
is_processed
boolean
Flag to verify if promotion is ready to be applied on cart. False value denotes promotion creation is in progress, while True value denotes promotion has been created successfully
calculate_on
string
Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type
Enum
author
object
Required
Properties
created_by
string
Required
ID of the user who created the promotion
modified_by
string
Required
ID of the user who last modified the promotion
approved_by
string|null
ID of the user who approved the promotion
rejected_by
string|null
ID of the user who rejected the promotion
reviewed_by
string|null
ID of the user who reviewed the promotion
currency
string
Required
ISO code of the currency
_schedule
object
Required
Properties
status
string
Status of the promotion
Enum
end
string|null
Promotion validity end date
cron
string|null
start
string|null
Required
Promotion validity start date
duration
integer|null
Required
published
boolean
Required
If promotion is published or marked inactive
next_schedule
array of object
Required
next schedule of the promotion
Array of Properties
end
string|null
end timestamp of the promotion
start
string|null
Required
start timestamp of the promotion
buy_rules
object
Required
Rules for purchases required to apply the promotion
date_meta
object
Required
Date details of promotion
Properties
created_on
string
Required
Promotion creation ISOdate
modified_on
string
Required
Promotion last modified ISOdate
approved_on
string|null
Promotion approved ISOdate
rejected_on
string|null
Promotion rejected ISOdate
reviewed_on
string|null
Promotion reviewed on ISOdate
ownership
object
ownership details of the promotion
Properties
payable_by
string|null
Required
who pays the promotion amount
payable_category
string
Required
category of the payer amount of promotion
stackable
boolean
Required
Indicates if promotion can be applied along with another promotion
promo_group
string
Required
Promotion group. Possible values: product, cart, contract, ladder_price
visiblility
object
Required
visibility details of promotion
Properties
pdp
boolean
Required
Show promotion on PDP page
coupon_list
boolean
Required
Show promotions under coupon list. Used when promotion mode is coupon
display_meta
object
Required
display details of promotion
Properties
name
string
Required
Name of promotion on Fynd Platform Panel
offer_text
string|null
Required
Promotional offer text to be shown on PDP or Cart
description
string|null
Required
Promotion T&C description
offer_label
string
Lable of the promotion offer
restrictions
object
Required
restrictions of promotions
Properties
user_type
string
User type based restriction on the promotion
email_domain
array of
List of email domains to restrict promotion
ordering_stores
array of
List of ordering stores to restrict promotion
uses
object
Required
defines usage details of promotion
Properties
maximum
object
Required
Defines maximum usage of promotion
Properties
user
integer
Required
Maximum usage of promotion per user
total
integer
Required
Maximum total usage of promotion
remaining
object
Required
Defines total usage of promotion
Properties
user
integer
Required
Remaining usage of promotion per user
total
integer
Required
Remaining total usage of promotion
user_id
array of Undefined Type
Required
List of only allowed user _ids for whom promotion should be applicable
payments
object
Defines allowed payments for promotion, all if empty
platforms
array of Undefined Type
Required
List of device platforms on which promotion is allowed. Possible values: web, ios, android
post_order
object
Required
post order actions allowed after order created with promotion
Properties
return_allowed
boolean
Required
Indicates whether customers can return an order purchased with promotion applied
cancellation_allowed
boolean
Required
Indicates whether customers can cancel an order purchased with promotion applied
user_groups
array of Undefined Type
List of user groups for whom promotion should be applicable
anonymous_users
boolean
Allow anonymous users to avail this promotion
user_registered
object
Required
Allow promotion to be applied for users registered within specified dates
Properties
end
string|null
end date of user registration
start
string|null
start date of user registration
application_id
string
Required
ID of the application (sales channel) where promotion is applicable
apply_priority
integer
Required
Priority of applying a promotion. Higher value promotions are applied first
discount_rules
array of Undefined Type
Required
Discount rules for the promotion
promotion_type
string
Required
Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom
apply_exclusive
string|null
If allowed, any other promotion after current promotion is applied. Possible values: article, cart, null
post_order_action
object
Details of post order action for the promotion
Properties
action_date
string|null
action data to be used to perform
action_type
string|null
action type to be performed after order placed with promotion
apply_all_discount
boolean
Required
Indicates whether multiple discount rules can be applied together or not
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        "promotion"
78      ],
79      "properties": {
80        "promotion": {
81          "type": "object",
82          "required": [
83            "display_meta",
84            "apply_priority",
85            "stackable",
86            "date_meta",
87            "application_id",
88            "discount_rules",
89            "apply_all_discount",
90            "currency",
91            "_schedule",
92            "mode",
93            "restrictions",
94            "promotion_type",
95            "_id",
96            "visiblility",
97            "buy_rules",
98            "author",
99            "promo_group"
100          ],
101          "properties": {
102            "_id": {
103              "type": "string",
104              "description": "ID of the promotion"
105            },
106            "mode": {
107              "type": "string",
108              "description": "Type of promotion. Possible values: promotion, coupon"
109            },
110            "code": {
111              "type": "string",
112              "description": "Promotion unique code"
113            },
114            "is_processed": {
115              "type": "boolean",
116              "description": "Flag to verify if promotion is ready to be applied on cart. False value denotes promotion creation is in progress, while True value denotes promotion has been created successfully"
117            },
118            "calculate_on": {
119              "type": "string",
120              "description": "Article Price on which promotion calculated like effective price or marked price. Only available for Contract pricing and Ladder pricing promotion type",
121              "enum": [
122                "mrp",
123                "esp"
124              ]
125            },
126            "author": {
127              "type": "object",
128              "required": [
129                "modified_by",
130                "created_by"
131              ],
132              "properties": {
133                "created_by": {
134                  "type": "string",
135                  "description": "ID of the user who created the promotion"
136                },
137                "modified_by": {
138                  "type": "string",
139                  "description": "ID of the user who last modified the promotion"
140                },
141                "approved_by": {
142                  "type": [
143                    "string",
144                    "null"
145                  ],
146                  "description": "ID of the user who approved the promotion"
147                },
148                "rejected_by": {
149                  "type": [
150                    "string",
151                    "null"
152                  ],
153                  "description": "ID of the user who rejected the promotion"
154                },
155                "reviewed_by": {
156                  "type": [
157                    "string",
158                    "null"
159                  ],
160                  "description": "ID of the user who reviewed the promotion"
161                }
162              }
163            },
164            "currency": {
165              "type": "string",
166              "description": "ISO code of the currency"
167            },
168            "_schedule": {
169              "type": "object",
170              "required": [
171                "duration",
172                "start",
173                "next_schedule",
174                "published"
175              ],
176              "properties": {
177                "status": {
178                  "type": "string",
179                  "enum": [
180                    "draft",
181                    "review",
182                    "rejected",
183                    "approved"
184                  ],
185                  "description": "Status of the promotion"
186                },
187                "end": {
188                  "type": [
189                    "string",
190                    "null"
191                  ],
192                  "description": "Promotion validity end date"
193                },
194                "cron": {
195                  "type": [
196                    "string",
197                    "null"
198                  ]
199                },
200                "start": {
201                  "type": [
202                    "string",
203                    "null"
204                  ],
205                  "description": "Promotion validity start date"
206                },
207                "duration": {
208                  "type": [
209                    "integer",
210                    "null"
211                  ]
212                },
213                "published": {
214                  "type": "boolean",
215                  "description": "If promotion is published or marked inactive"
216                },
217                "next_schedule": {
218                  "type": "array",
219                  "description": "next schedule of the promotion",
220                  "items": {
221                    "type": "object",
222                    "required": [
223                      "start"
224                    ],
225                    "properties": {
226                      "end": {
227                        "type": [
228                          "string",
229                          "null"
230                        ],
231                        "description": "end timestamp of the promotion"
232                      },
233                      "start": {
234                        "type": [
235                          "string",
236                          "null"
237                        ],
238                        "description": "start timestamp of the promotion"
239                      }
240                    }
241                  }
242                }
243              }
244            },
245            "buy_rules": {
246              "type": "object",
247              "description": "Rules for purchases required to apply the promotion",
248              "properties": {},
249              "additionalProperties": true
250            },
251            "date_meta": {
252              "type": "object",
253              "required": [
254                "created_on",
255                "modified_on"
256              ],
257              "description": "Date details of promotion",
258              "properties": {
259                "created_on": {
260                  "type": "string",
261                  "description": "Promotion creation ISOdate"
262                },
263                "modified_on": {
264                  "type": "string",
265                  "description": "Promotion last modified ISOdate"
266                },
267                "approved_on": {
268                  "type": [
269                    "string",
270                    "null"
271                  ],
272                  "description": "Promotion approved ISOdate"
273                },
274                "rejected_on": {
275                  "type": [
276                    "string",
277                    "null"
278                  ],
279                  "description": "Promotion rejected ISOdate"
280                },
281                "reviewed_on": {
282                  "type": [
283                    "string",
284                    "null"
285                  ],
286                  "description": "Promotion reviewed on ISOdate"
287                }
288              }
289            },
290            "ownership": {
291              "type": "object",
292              "description": "ownership details of the promotion",
293              "required": [
294                "payable_by",
295                "payable_category"
296              ],
297              "properties": {
298                "payable_by": {
299                  "type": [
300                    "string",
301                    "null"
302                  ],
303                  "description": "who pays the promotion amount"
304                },
305                "payable_category": {
306                  "type": "string",
307                  "description": "category of the payer amount of promotion"
308                }
309              }
310            },
311            "stackable": {
312              "type": "boolean",
313              "description": "Indicates if promotion can be applied along with another promotion"
314            },
315            "promo_group": {
316              "type": "string",
317              "description": "Promotion group. Possible values: product, cart, contract, ladder_price"
318            },
319            "visiblility": {
320              "type": "object",
321              "required": [
322                "pdp",
323                "coupon_list"
324              ],
325              "description": "visibility details of promotion",
326              "properties": {
327                "pdp": {
328                  "type": "boolean",
329                  "description": "Show promotion on PDP page"
330                },
331                "coupon_list": {
332                  "type": "boolean",
333                  "description": "Show promotions under coupon list. Used when promotion mode is coupon"
334                }
335              }
336            },
337            "display_meta": {
338              "type": "object",
339              "required": [
340                "offer_text",
341                "description",
342                "name"
343              ],
344              "description": "display details of promotion",
345              "properties": {
346                "name": {
347                  "type": "string",
348                  "description": "Name of promotion on Fynd Platform Panel"
349                },
350                "offer_text": {
351                  "type": [
352                    "string",
353                    "null"
354                  ],
355                  "description": "Promotional offer text to be shown on PDP or Cart"
356                },
357                "description": {
358                  "type": [
359                    "string",
360                    "null"
361                  ],
362                  "description": "Promotion T&C description"
363                },
364                "offer_label": {
365                  "type": "string",
366                  "description": "Lable of the promotion offer"
367                }
368              }
369            },
370            "restrictions": {
371              "type": "object",
372              "required": [
373                "user_registered",
374                "user_id",
375                "uses",
376                "post_order",
377                "platforms"
378              ],
379              "description": "restrictions of promotions",
380              "properties": {
381                "user_type": {
382                  "type": "string",
383                  "description": "User type based restriction on the promotion"
384                },
385                "email_domain": {
386                  "type": "array",
387                  "description": "List of email domains to restrict promotion"
388                },
389                "ordering_stores": {
390                  "type": "array",
391                  "description": "List of ordering stores to restrict promotion"
392                },
393                "uses": {
394                  "type": "object",
395                  "required": [
396                    "maximum",
397                    "remaining"
398                  ],
399                  "properties": {
400                    "maximum": {
401                      "type": "object",
402                      "required": [
403                        "user",
404                        "total"
405                      ],
406                      "properties": {
407                        "user": {
408                          "type": "integer",
409                          "description": "Maximum usage of promotion per user"
410                        },
411                        "total": {
412                          "type": "integer",
413                          "description": "Maximum total usage of promotion"
414                        }
415                      },
416                      "description": "Defines maximum usage of promotion"
417                    },
418                    "remaining": {
419                      "type": "object",
420                      "required": [
421                        "user",
422                        "total"
423                      ],
424                      "properties": {
425                        "user": {
426                          "type": "integer",
427                          "description": "Remaining usage of promotion per user"
428                        },
429                        "total": {
430                          "type": "integer",
431                          "description": "Remaining total usage of promotion"
432                        }
433                      },
434                      "description": "Defines total usage of promotion"
435                    }
436                  },
437                  "description": "defines usage details of promotion"
438                },
439                "user_id": {
440                  "type": "array",
441                  "items": {},
442                  "description": "List of only allowed user _ids for whom promotion should be applicable"
443                },
444                "payments": {
445                  "type": "object",
446                  "properties": {},
447                  "additionalProperties": true,
448                  "description": "Defines allowed payments for promotion, all if empty"
449                },
450                "platforms": {
451                  "type": "array",
452                  "items": [
453                    {
454                      "type": "string"
455                    }
456                  ],
457                  "description": "List of device platforms on which promotion is allowed. Possible values: web, ios, android"
458                },
459                "post_order": {
460                  "type": "object",
461                  "required": [
462                    "cancellation_allowed",
463                    "return_allowed"
464                  ],
465                  "properties": {
466                    "return_allowed": {
467                      "type": "boolean",
468                      "description": "Indicates whether customers can return an order purchased with promotion applied"
469                    },
470                    "cancellation_allowed": {
471                      "type": "boolean",
472                      "description": "Indicates whether customers can cancel an order purchased with promotion applied"
473                    }
474                  },
475                  "description": "post order actions allowed after order created with promotion"
476                },
477                "user_groups": {
478                  "type": "array",
479                  "items": {},
480                  "description": "List of user groups for whom promotion should be applicable"
481                },
482                "anonymous_users": {
483                  "type": "boolean",
484                  "description": "Allow anonymous users to avail this promotion"
485                },
486                "user_registered": {
487                  "type": "object",
488                  "properties": {
489                    "end": {
490                      "type": [
491                        "string",
492                        "null"
493                      ],
494                      "description": "end date of user registration"
495                    },
496                    "start": {
497                      "type": [
498                        "string",
499                        "null"
500                      ],
501                      "description": "start date of user registration"
502                    }
503                  },
504                  "description": "Allow promotion to be applied for users registered within specified dates"
505                }
506              }
507            },
508            "application_id": {
509              "type": "string",
510              "description": "ID of the application (sales channel) where promotion is applicable"
511            },
512            "apply_priority": {
513              "type": "integer",
514              "description": "Priority of applying a promotion. Higher value promotions are applied first"
515            },
516            "discount_rules": {
517              "type": "array",
518              "items": [
519                {
520                  "type": "object",
521                  "required": [
522                    "item_criteria",
523                    "discount_type",
524                    "buy_condition",
525                    "offer"
526                  ],
527                  "properties": {
528                    "offer": {
529                      "type": "object",
530                      "properties": {
531                        "discount_percentage": {
532                          "type": "number",
533                          "format": "float",
534                          "description": "Percentage of the discount given"
535                        },
536                        "discount_amount": {
537                          "type": "number",
538                          "format": "float",
539                          "description": "Amount of the discount given"
540                        },
541                        "max_offer_quantity": {
542                          "type": "integer",
543                          "description": "Max  offer for the given discount"
544                        },
545                        "min_offer_quantity": {
546                          "type": "integer",
547                          "description": "Min  offer for the given discount"
548                        }
549                      },
550                      "description": "Offer given by promotion"
551                    },
552                    "buy_condition": {
553                      "type": "string",
554                      "description": "buy condition of rules for the promotion"
555                    },
556                    "discount_type": {
557                      "type": "string",
558                      "description": "type of discount by promotion"
559                    },
560                    "item_criteria": {
561                      "type": "object",
562                      "properties": {
563                        "item_store": {
564                          "type": "array",
565                          "items": {
566                            "type": "integer"
567                          },
568                          "description": "The unique identifier of the item store."
569                        },
570                        "item_id": {
571                          "type": "array",
572                          "items": {
573                            "type": "integer"
574                          },
575                          "description": "The unique identifier of the item."
576                        },
577                        "all_items": {
578                          "type": "boolean",
579                          "description": "Used for attaching all products for the promotion"
580                        },
581                        "buy_rules": {
582                          "type": "array",
583                          "items": {
584                            "type": "string"
585                          }
586                        }
587                      },
588                      "description": "item criteria that should meet to apply the promotion"
589                    },
590                    "meta": {
591                      "type": "object",
592                      "properties": {},
593                      "additionalProperties": true,
594                      "description": "Meta data of the discount."
595                    }
596                  }
597                }
598              ],
599              "description": "Discount rules for the promotion"
600            },
601            "promotion_type": {
602              "type": "string",
603              "description": "Promotion Type. Possible values: percentage, amount, fixed_price, bogo, contract_price, ladder_price, custom"
604            },
605            "apply_exclusive": {
606              "type": [
607                "string",
608                "null"
609              ],
610              "description": "If allowed, any other promotion after current promotion is applied. Possible values: article, cart, null"
611            },
612            "post_order_action": {
613              "type": "object",
614              "properties": {
615                "action_date": {
616                  "type": [
617                    "string",
618                    "null"
619                  ],
620                  "description": "action data to be used to perform "
621                },
622                "action_type": {
623                  "type": [
624                    "string",
625                    "null"
626                  ],
627                  "description": "action type to be performed after order placed with promotion"
628                }
629              },
630              "description": "Details of post order action for the promotion"
631            },
632            "apply_all_discount": {
633              "type": "boolean",
634              "description": "Indicates whether multiple discount rules can be applied together or not"
635            }
636          }
637        }
638      }
639    }
640  }
641}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.3285dc2a-49de-4bec-b86c-39918b2ed0f5"
5    ],
6    "name": "promotion",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711615911887,
10    "id": "7Fy18D99MxxCtbzaGBv4ATqlO+P7ujzPUDTGFIRt+aU=",
11    "category": "application"
12  },
13  "company_id": 6440,
14  "application_id": "657d3e74cc90c6a66842e990",
15  "contains": [
16    "promotion"
17  ],
18  "payload": {
19    "promotion": {
20      "calculate_on": "esp",
21      "is_processed": true,
22      "code": "example_code",
23      "date_meta": {
24        "modified_on": "2024-03-28T08:51:51.871778+00:00",
25        "created_on": "2024-03-28T08:50:54.397000+00:00"
26      },
27      "apply_exclusive": null,
28      "currency": "INR",
29      "restrictions": {
30        "user_registered": {
31          "start": null,
32          "end": null
33        },
34        "user_id": [],
35        "uses": {
36          "maximum": {
37            "total": 0,
38            "user": 0
39          },
40          "remaining": {
41            "total": 0,
42            "user": 0
43          }
44        },
45        "user_groups": [],
46        "user_type": "all_user",
47        "ordering_stores": [],
48        "post_order": {
49          "return_allowed": true,
50          "cancellation_allowed": true
51        },
52        "email_domain": [],
53        "platforms": [
54          "web",
55          "android",
56          "ios"
57        ],
58        "payments": {}
59      },
60      "application_id": "657d3e74cc90c6a66842e990",
61      "author": {
62        "modified_by": "c5c674ac6533f964a0b5948f",
63        "created_by": "c5c674ac6533f964a0b5948f"
64      },
65      "promotion_type": "percentage",
66      "display_meta": {
67        "name": "Test",
68        "description": "<p>Test 50</p>",
69        "offer_text": "50",
70        "offer_label": ""
71      },
72      "discount_rules": [
73        {
74          "offer": {
75            "discount_percentage": 50
76          },
77          "buy_condition": "( rule#1 )",
78          "discount_type": "percentage",
79          "item_criteria": {
80            "item_store": [
81              22754
82            ]
83          }
84        }
85      ],
86      "apply_priority": 1,
87      "_schedule": {
88        "duration": 0,
89        "next_schedule": [
90          {
91            "start": "2024-03-28T08:49:37+00:00",
92            "end": "2024-03-29T18:30:00+00:00"
93          }
94        ],
95        "start": "2024-03-28T08:49:37+00:00",
96        "end": "2024-03-29T18:30:00+00:00",
97        "cron": "",
98        "published": true
99      },
100      "promo_group": "product",
101      "mode": "promotion",
102      "ownership": {
103        "payable_category": "seller",
104        "payable_by": ""
105      },
106      "stackable": true,
107      "visiblility": {
108        "pdp": true,
109        "coupon_list": false
110      },
111      "post_order_action": {
112        "action_date": null,
113        "action_type": ""
114      },
115      "apply_all_discount": false,
116      "_id": "66052f6e59001f59ae1bec27",
117      "buy_rules": {
118        "rule#1": {
119          "cart_quantity": {
120            "greater_than": 10,
121            "equals": 10
122          }
123        },
124        "rule#2": {
125          "item_brand": [
126            7594
127          ]
128        }
129      }
130    }
131  }
132}

Promotion usage

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

Events
application/promotion_usage/update/v1
# this event is triggered when promotion_usage is updated

application/promotion_usage/update/v1

this event is triggered when promotion_usage 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
promotion_usage
object
Required
Properties
app_id
string
Required
ID of the application (sales channel) where promotion is used
user_id
string
Required
User's _id for which promotion usage count event is triggered
_version
integer
Required
Document version key. Since event throughput is high, event generation order might be different and latest event might get triggered first. Doc version can be used to discard old event data.
usage_count
integer
Required
Total order count for current user during the promotional period
promotion_id
string
Required
ID of the promotion
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        "promotion_usage"
78      ],
79      "properties": {
80        "promotion_usage": {
81          "type": "object",
82          "required": [
83            "promotion_id",
84            "usage_count",
85            "user_id",
86            "app_id",
87            "_version"
88          ],
89          "properties": {
90            "app_id": {
91              "type": "string",
92              "description": "ID of the application (sales channel) where promotion is used"
93            },
94            "user_id": {
95              "type": "string",
96              "description": "User's _id for which promotion usage count event is triggered"
97            },
98            "_version": {
99              "type": "integer",
100              "description": "Document version key. Since event throughput is high, event generation order might be different and latest event might get triggered first. Doc version can be used to discard old event data."
101            },
102            "usage_count": {
103              "type": "integer",
104              "description": "Total order count for current user during the promotional period"
105            },
106            "promotion_id": {
107              "type": "string",
108              "description": "ID of the promotion"
109            }
110          }
111        }
112      }
113    }
114  }
115}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "megatron.43891ecb-3187-4405-bf99-89ceea8b9104"
5    ],
6    "name": "promotion_usage",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711531216651,
10    "id": "5FcBBAtYvCCAIYqM7m1mt1Ii9E/7Ur5bV4bRwbxvQoc=",
11    "category": "application"
12  },
13  "company_id": 5842,
14  "application_id": "6523fa5f41f4eb4c10a1d869",
15  "contains": [
16    "promotion_usage"
17  ],
18  "payload": {
19    "promotion_usage": {
20      "user_id": "65d73a6c2ef8415265228bb2",
21      "app_id": "6523fa5f41f4eb4c10a1d869",
22      "promotion_id": "66002a96b7a27a70b821e3f2",
23      "usage_count": 1,
24      "_version": 1
25    }
26  }
27}

Refund

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

Events
application/refund/refund_done/v1
# this event is triggered when refund is refund_done
application/refund/refund_failed/v1
# this event is triggered when refund is refund_failed
application/refund/refund_initiated/v1
# this event is triggered when refund is refund_initiated
application/refund/refund_pending/v1
# this event is triggered when refund is refund_pending

application/refund/refund_done/v1

this event is triggered when refund is refund_done

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
amount
number
The Amount to be refunded.
order_id
string
Required
It is the unique id of Order.
journey_type
string
Required
Cancallation or return journey for refund.
payment_status
string
Required
Status of the payment.
merchant_order_id
string
Required
This is the unique id of merchant order.
merchant_refund_id
string
Required
This is the unique id of merchant refund.
refund_information
array of object
Required
Array of Properties
meta
object
mode
string
Required
Payment mode via which refund need to be done.
name
string
Required
The Name of the Mode.
amount
number
Required
The Amount to be refunded.
refund_by
string
Required
Whomsoever will refund the money.
collect_by
string
Required
Whomsoever collected the money.
payout_details
object
Payout deatils of refunded mode.
refund_details
object
Properties
ref
string|null
Bank reference id of refund.
amount
number
Required
Amount refunded.
bag_id
string
Required
Unique id of the bag.
status
string
Required
Show what the current status of the transaction (Pending, Success or failed).
message
string|null
Refund message from payment gateway.
success
boolean
Required
Refund success boolean flag.
journey_type
string|null
Cancallation or return journey for refund.
payment_status
string
Required
Status of the payment.
payout_details
object
Payout details of refunded mode.
transaction_id
string|null
Refund transaction id of Fynd platform.
error_traceback
string|null
Complete error traceback of refund failed.
pg_reference_id
string|null
PG refunded reference id.
credit_reinstated
string|null
User credit reactivated after repayment.
unique_request_id
string|null
Unique request id of refund initiation.
merchant_refund_id
string
Required
This is the unique id of merchant refund id.
payment_gateway
string
Via which payment gateway refund need to be done.
merchant_order_id
string
This is the unique id of order.
payment_identifier
string
Payment sub payment mode identifier.
transaction_timestamp
string|null
Refund transaction unix timestamp.
forward_shipment_id
string|null
This is the shipment id.
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        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id",
82        "payment_status"
83      ],
84      "properties": {
85        "amount": {
86          "type": "number",
87          "description": "The Amount to be refunded."
88        },
89        "order_id": {
90          "type": "string",
91          "description": "It is the unique id of Order."
92        },
93        "journey_type": {
94          "type": "string",
95          "description": "Cancallation or return journey for refund."
96        },
97        "payment_status": {
98          "type": "string",
99          "description": "Status of the payment."
100        },
101        "merchant_order_id": {
102          "type": "string",
103          "description": "This is the unique id of merchant order."
104        },
105        "merchant_refund_id": {
106          "type": "string",
107          "description": "This is the unique id of merchant refund."
108        },
109        "refund_information": {
110          "type": "array",
111          "items": {
112            "type": "object",
113            "required": [
114              "amount",
115              "mode",
116              "name",
117              "collect_by",
118              "refund_by"
119            ],
120            "properties": {
121              "meta": {
122                "type": "object"
123              },
124              "mode": {
125                "type": "string",
126                "description": "Payment mode via which refund need to be done."
127              },
128              "name": {
129                "type": "string",
130                "description": "The Name of the Mode."
131              },
132              "amount": {
133                "type": "number",
134                "description": "The Amount to be refunded."
135              },
136              "refund_by": {
137                "type": "string",
138                "description": "Whomsoever will refund the money."
139              },
140              "collect_by": {
141                "type": "string",
142                "description": "Whomsoever collected the money."
143              },
144              "payout_details": {
145                "type": "object",
146                "description": "Payout deatils of refunded mode."
147              },
148              "refund_details": {
149                "type": "object",
150                "required": [
151                  "bag_id",
152                  "status",
153                  "amount",
154                  "merchant_refund_id",
155                  "success",
156                  "payment_status"
157                ],
158                "properties": {
159                  "ref": {
160                    "type": [
161                      "string",
162                      "null"
163                    ],
164                    "description": "Bank reference id of refund."
165                  },
166                  "amount": {
167                    "type": "number",
168                    "description": "Amount refunded."
169                  },
170                  "bag_id": {
171                    "type": "string",
172                    "description": "Unique id of the bag."
173                  },
174                  "status": {
175                    "type": "string",
176                    "description": "Show what the current status of the transaction (Pending, Success or failed)."
177                  },
178                  "message": {
179                    "type": [
180                      "string",
181                      "null"
182                    ],
183                    "description": "Refund message from payment gateway."
184                  },
185                  "success": {
186                    "type": "boolean",
187                    "description": "Refund success boolean flag."
188                  },
189                  "journey_type": {
190                    "type": [
191                      "string",
192                      "null"
193                    ],
194                    "description": "Cancallation or return journey for refund."
195                  },
196                  "payment_status": {
197                    "type": "string",
198                    "description": "Status of the payment."
199                  },
200                  "payout_details": {
201                    "type": "object",
202                    "description": "Payout details of refunded mode."
203                  },
204                  "transaction_id": {
205                    "type": [
206                      "string",
207                      "null"
208                    ],
209                    "description": "Refund transaction id of Fynd platform."
210                  },
211                  "error_traceback": {
212                    "type": [
213                      "string",
214                      "null"
215                    ],
216                    "description": "Complete error traceback of refund failed."
217                  },
218                  "pg_reference_id": {
219                    "type": [
220                      "string",
221                      "null"
222                    ],
223                    "description": "PG refunded reference id."
224                  },
225                  "credit_reinstated": {
226                    "type": [
227                      "string",
228                      "null"
229                    ],
230                    "description": "User credit reactivated after repayment."
231                  },
232                  "unique_request_id": {
233                    "type": [
234                      "string",
235                      "null"
236                    ],
237                    "description": "Unique request id of refund initiation."
238                  },
239                  "merchant_refund_id": {
240                    "type": "string",
241                    "description": "This is the unique id of merchant refund id."
242                  }
243                }
244              },
245              "payment_gateway": {
246                "type": "string",
247                "description": "Via which payment gateway refund need to be done."
248              },
249              "merchant_order_id": {
250                "type": "string",
251                "description": "This is the unique id of order."
252              },
253              "payment_identifier": {
254                "type": "string",
255                "description": "Payment sub payment mode identifier."
256              },
257              "transaction_timestamp": {
258                "type": [
259                  "string",
260                  "null"
261                ],
262                "description": "Refund transaction unix timestamp."
263              }
264            }
265          }
266        },
267        "forward_shipment_id": {
268          "type": [
269            "string",
270            "null"
271          ],
272          "description": "This is the shipment id."
273        }
274      }
275    }
276  }
277}
Payload Example
1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "merchant_order_id",
6    "forward_shipment_id",
7    "refund_information",
8    "order_id",
9    "journey_type",
10    "merchant_refund_id",
11    "payment_status"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1709888766983,
16    "id": "pE+z6QTnSfB+5kwRF1bM/BTUVu8oNTUNfM23+yKw318=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_done",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17094000377291693395",
24    "journey_type": "RETURN",
25    "merchant_order_id": "FY65E35FE50E388CAD4D",
26    "merchant_refund_id": "17098100629891965689",
27    "order_id": "FY65E35FE50E388CAD4D",
28    "payment_status": "refund_done",
29    "refund_information": [
30      {
31        "amount": 6999,
32        "collect_by": "fynd",
33        "meta": {
34          "id": "FY65E35FE50E388CAD4D",
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"
38          },
39          "mode": "",
40          "payment_id": null
41        },
42        "mode": "PP",
43        "name": "PartnerPay",
44        "refund_by": "fynd",
45        "refund_details": {
46          "amount": 6999,
47          "bag_id": "17098100629891965689",
48          "error_traceback": null,
49          "journey_type": "RETURN",
50          "merchant_refund_id": "17098100629891965689",
51          "message": "data fetched",
52          "payment_status": "refund_done",
53          "payout_details": {
54            "acquirer_data": {
55              "rrn": null
56            },
57            "amount": 699900,
58            "batch_id": "",
59            "created_at": 1709888766,
60            "currency": "INR",
61            "entity": "refund",
62            "id": "rfnd_NjnzpKdBhN4YDY",
63            "notes": {
64              "merchant_refund_id": "17098100629891965689"
65            },
66            "payment_id": "pay_NhZE3htyDN2K4z",
67            "receipt": "17098100629891965689",
68            "speed_processed": "normal",
69            "speed_requested": "normal",
70            "status": "processed"
71          },
72          "pg_reference_id": "rfnd_NjnzpKdBhN4YDY",
73          "ref": "rfnd_NjnzpKdBhN4YDY",
74          "status": "refund_done",
75          "success": true,
76          "transaction_id": null,
77          "unique_request_id": "rfnd_NjnzpKdBhN4YDY"
78        }
79      }
80    ]
81  }
82}

application/refund/refund_failed/v1

this event is triggered when refund is refund_failed

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
amount
number
The Amount to be refunded
order_id
string
Required
It is the unique id of Order
journey_type
string
Required
Cancallation or return journey for refund.
payment_status
string
Status of the payment
merchant_order_id
string
Required
This is the unique id of order
merchant_refund_id
string
Required
This is the unique id of order
refund_information
array of object
Required
Array of Properties
meta
object
Open meta dictionary of refund information.
mode
string
Required
Payment mode via which refund need to be done
name
string
Required
The Name of the Mode
amount
number
Required
The Amount to be refunded
refund_by
string
Required
Whomsoever will refund the money
collect_by
string
Required
Whomsoever collected the money
payout_details
object
Payout details of refunded mode.
refund_details
object
Properties
ref
string|null
The ref is the Id that we get as a response from the payment gateway
amount
number
The Amount to be refunded
bag_id
string
Unique id of the bag
status
string
Show what the current status of the transaction (Pending, Success or failed)
message
string|null
Refund message from payment gateway.
success
boolean
Show whether the transaction is successful or not
journey_type
string|null
Cancallation or return journey for refund.
payment_status
string
Status of the payment
payout_details
object
Payout details of refunded mode.
transaction_id
string|null
Refund transaction id of Fynd platform.
error_traceback
string|null
Complete error traceback of refund failed.
pg_reference_id
string|null
PG refunded reference id.
credit_reinstated
string|null
User credit reactivated after repayment.
unique_request_id
string|null
Unique request id of refund initiation.
merchant_refund_id
string
This is the unique id of order
payment_gateway
string
Via which payment gateway refund need to be done
merchant_order_id
string
This is the unique id of order
payment_identifier
string
Payment sub payment mode identifier.
transaction_timestamp
string|null
Refund transaction unix timestamp.
forward_shipment_id
string|null
Unique id of the bag
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        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The Amount to be refunded"
87        },
88        "order_id": {
89          "type": "string",
90          "description": "It is the unique id of Order"
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund. "
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment"
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of order"
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of order"
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object",
122                "description": "Open meta dictionary of refund information."
123              },
124              "mode": {
125                "type": "string",
126                "description": "Payment mode via which refund need to be done"
127              },
128              "name": {
129                "type": "string",
130                "description": "The Name of the Mode"
131              },
132              "amount": {
133                "type": "number",
134                "description": "The Amount to be refunded"
135              },
136              "refund_by": {
137                "type": "string",
138                "description": "Whomsoever will refund the money"
139              },
140              "collect_by": {
141                "type": "string",
142                "description": "Whomsoever collected the money"
143              },
144              "payout_details": {
145                "type": "object",
146                "description": "Payout details of refunded mode."
147              },
148              "refund_details": {
149                "type": "object",
150                "properties": {
151                  "ref": {
152                    "type": [
153                      "string",
154                      "null"
155                    ],
156                    "description": "The ref is the Id that we get as a response from the payment gateway"
157                  },
158                  "amount": {
159                    "type": "number",
160                    "description": "The Amount to be refunded"
161                  },
162                  "bag_id": {
163                    "type": "string",
164                    "description": "Unique id of the bag"
165                  },
166                  "status": {
167                    "type": "string",
168                    "description": "Show what the current status of the transaction (Pending, Success or failed)"
169                  },
170                  "message": {
171                    "type": [
172                      "string",
173                      "null"
174                    ],
175                    "description": "Refund message from payment gateway."
176                  },
177                  "success": {
178                    "type": "boolean",
179                    "description": "Show whether the transaction is successful or not"
180                  },
181                  "journey_type": {
182                    "type": [
183                      "string",
184                      "null"
185                    ],
186                    "description": "Cancallation or return journey for refund."
187                  },
188                  "payment_status": {
189                    "type": "string",
190                    "description": "Status of the payment"
191                  },
192                  "payout_details": {
193                    "type": "object",
194                    "description": "Payout details of refunded mode."
195                  },
196                  "transaction_id": {
197                    "type": [
198                      "string",
199                      "null"
200                    ],
201                    "description": "Refund transaction id of Fynd platform."
202                  },
203                  "error_traceback": {
204                    "type": [
205                      "string",
206                      "null"
207                    ],
208                    "description": "Complete error traceback of refund failed."
209                  },
210                  "pg_reference_id": {
211                    "type": [
212                      "string",
213                      "null"
214                    ],
215                    "description": "PG refunded reference id."
216                  },
217                  "credit_reinstated": {
218                    "type": [
219                      "string",
220                      "null"
221                    ],
222                    "description": "User credit reactivated after repayment."
223                  },
224                  "unique_request_id": {
225                    "type": [
226                      "string",
227                      "null"
228                    ],
229                    "description": "Unique request id of refund initiation."
230                  },
231                  "merchant_refund_id": {
232                    "type": "string",
233                    "description": "This is the unique id of order"
234                  }
235                }
236              },
237              "payment_gateway": {
238                "type": "string",
239                "description": "Via which payment gateway refund need to be done"
240              },
241              "merchant_order_id": {
242                "type": "string",
243                "description": "This is the unique id of order"
244              },
245              "payment_identifier": {
246                "type": "string",
247                "description": "Payment sub payment mode identifier."
248              },
249              "transaction_timestamp": {
250                "type": [
251                  "string",
252                  "null"
253                ],
254                "description": "Refund transaction unix timestamp."
255              }
256            }
257          }
258        },
259        "forward_shipment_id": {
260          "type": [
261            "string",
262            "null"
263          ],
264          "description": "Unique id of the bag"
265        }
266      }
267    }
268  }
269}
Payload Example
1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "refund_information",
6    "payment_status",
7    "forward_shipment_id",
8    "merchant_refund_id",
9    "merchant_order_id",
10    "order_id",
11    "journey_type"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1708966106532,
16    "id": "f5unLVyao4mq4bFI4vp9kl16YkzujEk4cSlJwtZDU9I=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_failed",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": null,
24    "journey_type": "RETURN",
25    "merchant_order_id": "1233123",
26    "merchant_refund_id": "123",
27    "order_id": "FY65BD3A0D0E8EB05F77",
28    "payment_status": "refund_failed",
29    "refund_information": [
30      {
31        "amount": 14999,
32        "collect_by": "fynd",
33        "meta": {
34          "logo_url": {
35            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png",
36            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png"
37          },
38          "mode": ""
39        },
40        "mode": "COD",
41        "name": "COD",
42        "refund_by": "fynd"
43      }
44    ]
45  }
46}

application/refund/refund_initiated/v1

this event is triggered when refund is refund_initiated

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
amount
number
The Amount to be refunded
order_id
string
Required
It is the unique id of Order
journey_type
string
Required
Cancallation or return journey for refund.
payment_status
string
Status of the payment
merchant_order_id
string
Required
This is the unique id of order
merchant_refund_id
string
Required
This is the unique id of order
refund_information
array of object
Required
Array of Properties
meta
object
mode
string
Required
Payment mode via which refund need to be done
name
string
Required
The Name of the Mode
amount
number
Required
The Amount to be refunded
refund_by
string
Required
Whomsoever will refund the money
collect_by
string
Required
Whomsoever collected the money
payout_details
object
Payout details of refunded mode.
refund_details
object
Properties
ref
string|null
The ref is the Id that we get as a response from payment gateway
amount
number
The Amount to be refunded
bag_id
string
Unique id of the bag
status
string
Show what the current status of the transaction (Pending, Success or failed)
message
string|null
Refund message from payment gateway.
success
boolean
Show whether the transaction is successful or not
journey_type
string|null
Cancallation or return journey for refund.
payment_status
string
Status of the payment
payout_details
object
Payout details of refunded mode.
transaction_id
string|null
Refund transaction id of Fynd platform.
error_traceback
string|null
Complete error traceback of refund failed.
pg_reference_id
string|null
PG refunded reference id.
credit_reinstated
string|null
User credit reactivated after repayment.
unique_request_id
string|null
Unique request id of refund initiation.
merchant_refund_id
string
This is the unique id of order
payment_gateway
string
Via which payment gateway refund need to be done
merchant_order_id
string
This is the unique id of order
payment_identifier
string
Payment sub payment mode identifier.
transaction_timestamp
string|null
Refund transaction unix timestamp.
forward_shipment_id
string|null
This is the shipment id
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        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The Amount to be refunded"
87        },
88        "order_id": {
89          "type": "string",
90          "description": "It is the unique id of Order"
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund."
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment"
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of order"
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of order"
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object"
122              },
123              "mode": {
124                "type": "string",
125                "description": "Payment mode via which refund need to be done"
126              },
127              "name": {
128                "type": "string",
129                "description": "The Name of the Mode"
130              },
131              "amount": {
132                "type": "number",
133                "description": "The Amount to be refunded"
134              },
135              "refund_by": {
136                "type": "string",
137                "description": "Whomsoever will refund the money"
138              },
139              "collect_by": {
140                "type": "string",
141                "description": "Whomsoever collected the money"
142              },
143              "payout_details": {
144                "type": "object",
145                "description": "Payout details of refunded mode."
146              },
147              "refund_details": {
148                "type": "object",
149                "properties": {
150                  "ref": {
151                    "type": [
152                      "string",
153                      "null"
154                    ],
155                    "description": "The ref is the Id that we get as a response from payment gateway"
156                  },
157                  "amount": {
158                    "type": "number",
159                    "description": "The Amount to be refunded"
160                  },
161                  "bag_id": {
162                    "type": "string",
163                    "description": "Unique id of the bag"
164                  },
165                  "status": {
166                    "type": "string",
167                    "description": "Show what the current status of the transaction (Pending, Success or failed)"
168                  },
169                  "message": {
170                    "type": [
171                      "string",
172                      "null"
173                    ],
174                    "description": "Refund message from payment gateway."
175                  },
176                  "success": {
177                    "type": "boolean",
178                    "description": "Show whether the transaction is successful or not"
179                  },
180                  "journey_type": {
181                    "type": [
182                      "string",
183                      "null"
184                    ],
185                    "description": "Cancallation or return journey for refund."
186                  },
187                  "payment_status": {
188                    "type": "string",
189                    "description": "Status of the payment"
190                  },
191                  "payout_details": {
192                    "type": "object",
193                    "description": "Payout details of refunded mode."
194                  },
195                  "transaction_id": {
196                    "type": [
197                      "string",
198                      "null"
199                    ],
200                    "description": "Refund transaction id of Fynd platform."
201                  },
202                  "error_traceback": {
203                    "type": [
204                      "string",
205                      "null"
206                    ],
207                    "description": "Complete error traceback of refund failed."
208                  },
209                  "pg_reference_id": {
210                    "type": [
211                      "string",
212                      "null"
213                    ],
214                    "description": "PG refunded reference id."
215                  },
216                  "credit_reinstated": {
217                    "type": [
218                      "string",
219                      "null"
220                    ],
221                    "description": "User credit reactivated after repayment."
222                  },
223                  "unique_request_id": {
224                    "type": [
225                      "string",
226                      "null"
227                    ],
228                    "description": "Unique request id of refund initiation."
229                  },
230                  "merchant_refund_id": {
231                    "type": "string",
232                    "description": "This is the unique id of order"
233                  }
234                }
235              },
236              "payment_gateway": {
237                "type": "string",
238                "description": "Via which payment gateway refund need to be done"
239              },
240              "merchant_order_id": {
241                "type": "string",
242                "description": "This is the unique id of order"
243              },
244              "payment_identifier": {
245                "type": "string",
246                "description": "Payment sub payment mode identifier."
247              },
248              "transaction_timestamp": {
249                "type": [
250                  "string",
251                  "null"
252                ],
253                "description": "Refund transaction unix timestamp."
254              }
255            }
256          }
257        },
258        "forward_shipment_id": {
259          "type": [
260            "string",
261            "null"
262          ],
263          "description": "This is the shipment id"
264        }
265      }
266    }
267  }
268}
Payload Example
1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "order_id",
6    "merchant_refund_id",
7    "merchant_order_id",
8    "payment_status",
9    "journey_type",
10    "forward_shipment_id",
11    "refund_information"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1708969365959,
16    "id": "CZLDHllU18amt/9joTz9+/IfRsr7UfEjG0KDE35xeMk=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_initiated",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17089681204691081665",
24    "journey_type": "CANCELLED_CUSTOMER",
25    "merchant_order_id": "2313",
26    "merchant_refund_id": "123123",
27    "order_id": "FY65DCC8B80E8F44EAF1",
28    "payment_status": "refund_initiated",
29    "refund_information": [
30      {
31        "amount": 5995,
32        "collect_by": "fynd",
33        "meta": {
34          "id": "FY65DCC8B80E8F44EAF1",
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"
38          },
39          "mode": "",
40          "payment_id": null
41        },
42        "mode": "PP",
43        "name": "PartnerPay",
44        "refund_by": "fynd"
45      }
46    ]
47  }
48}

application/refund/refund_pending/v1

this event is triggered when refund is refund_pending

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
amount
number
The amount to be refunded.
order_id
string
Required
The unique id of the Order.
journey_type
string
Required
Cancallation or return journey for refund.
payment_status
string
Status of the payment.
merchant_order_id
string
Required
This is the unique id of the order.
merchant_refund_id
string
Required
This is the unique id of the order.
refund_information
array of object
Required
Array of Properties
meta
object
mode
string
Required
Payment mode via which the refund needs to be done.
name
string
Required
The name of the payment mode.
amount
number
Required
The amount to be refunded.
refund_by
string
Required
Whomsoever will refund the money.
collect_by
string
Required
Whomsoever collected the money.
payout_details
object
Payout details of refunded mode.
refund_details
object
Properties
ref
string|null
The Bank ref is the Id that we get as a response from the payment gateway.
amount
number
The amount to be refunded.
bag_id
string
Unique id of the bag.
status
string
Show what the current status of the transaction (Pending, Success or failed).
message
string|null
Refund message from payment gateway.
success
boolean
Show whether the transaction is successful or not.
journey_type
string|null
Cancallation or return journey for refund.
payment_status
string
Status of the payment.
payout_details
object
Payout details of refunded mode.
transaction_id
string|null
Refund transaction id of Fynd platform.
error_traceback
string|null
Complete error traceback of refund failed.
pg_reference_id
string|null
PG refunded reference id.
credit_reinstated
string|null
User credit reactivated after repayment.
unique_request_id
string|null
Unique request id of refund initiation.
merchant_refund_id
string
This is the unique id of the order.
payment_gateway
string
Via which payment gateway the refund needs to be done.
merchant_order_id
string
This is the unique id of the order.
payment_identifier
string
Payment sub payment mode identifier.
transaction_timestamp
string|null
Refund transaction unix timestamp.
forward_shipment_id
string|null
This is the shipment id.
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        "order_id",
78        "refund_information",
79        "merchant_refund_id",
80        "journey_type",
81        "merchant_order_id"
82      ],
83      "properties": {
84        "amount": {
85          "type": "number",
86          "description": "The amount to be refunded."
87        },
88        "order_id": {
89          "type": "string",
90          "description": "The unique id of the Order."
91        },
92        "journey_type": {
93          "type": "string",
94          "description": "Cancallation or return journey for refund."
95        },
96        "payment_status": {
97          "type": "string",
98          "description": "Status of the payment."
99        },
100        "merchant_order_id": {
101          "type": "string",
102          "description": "This is the unique id of the order."
103        },
104        "merchant_refund_id": {
105          "type": "string",
106          "description": "This is the unique id of the order."
107        },
108        "refund_information": {
109          "type": "array",
110          "items": {
111            "type": "object",
112            "required": [
113              "amount",
114              "mode",
115              "name",
116              "collect_by",
117              "refund_by"
118            ],
119            "properties": {
120              "meta": {
121                "type": "object"
122              },
123              "mode": {
124                "type": "string",
125                "description": "Payment mode via which the refund needs to be done."
126              },
127              "name": {
128                "type": "string",
129                "description": "The name of the payment mode."
130              },
131              "amount": {
132                "type": "number",
133                "description": "The amount to be refunded."
134              },
135              "refund_by": {
136                "type": "string",
137                "description": "Whomsoever will refund the money."
138              },
139              "collect_by": {
140                "type": "string",
141                "description": "Whomsoever collected the money."
142              },
143              "payout_details": {
144                "type": "object",
145                "description": "Payout details of refunded mode."
146              },
147              "refund_details": {
148                "type": "object",
149                "properties": {
150                  "ref": {
151                    "type": [
152                      "string",
153                      "null"
154                    ],
155                    "description": "The Bank ref is the Id that we get as a response from the payment gateway."
156                  },
157                  "amount": {
158                    "type": "number",
159                    "description": "The amount to be refunded."
160                  },
161                  "bag_id": {
162                    "type": "string",
163                    "description": "Unique id of the bag."
164                  },
165                  "status": {
166                    "type": "string",
167                    "description": "Show what the current status of the transaction (Pending, Success or failed)."
168                  },
169                  "message": {
170                    "type": [
171                      "string",
172                      "null"
173                    ],
174                    "description": "Refund message from payment gateway."
175                  },
176                  "success": {
177                    "type": "boolean",
178                    "description": "Show whether the transaction is successful or not."
179                  },
180                  "journey_type": {
181                    "type": [
182                      "string",
183                      "null"
184                    ],
185                    "description": "Cancallation or return journey for refund."
186                  },
187                  "payment_status": {
188                    "type": "string",
189                    "description": "Status of the payment."
190                  },
191                  "payout_details": {
192                    "type": "object",
193                    "description": "Payout details of refunded mode."
194                  },
195                  "transaction_id": {
196                    "type": [
197                      "string",
198                      "null"
199                    ],
200                    "description": "Refund transaction id of Fynd platform."
201                  },
202                  "error_traceback": {
203                    "type": [
204                      "string",
205                      "null"
206                    ],
207                    "description": "Complete error traceback of refund failed."
208                  },
209                  "pg_reference_id": {
210                    "type": [
211                      "string",
212                      "null"
213                    ],
214                    "description": "PG refunded reference id."
215                  },
216                  "credit_reinstated": {
217                    "type": [
218                      "string",
219                      "null"
220                    ],
221                    "description": "User credit reactivated after repayment."
222                  },
223                  "unique_request_id": {
224                    "type": [
225                      "string",
226                      "null"
227                    ],
228                    "description": "Unique request id of refund initiation."
229                  },
230                  "merchant_refund_id": {
231                    "type": "string",
232                    "description": "This is the unique id of the order."
233                  }
234                }
235              },
236              "payment_gateway": {
237                "type": "string",
238                "description": "Via which payment gateway the refund needs to be done."
239              },
240              "merchant_order_id": {
241                "type": "string",
242                "description": "This is the unique id of the order."
243              },
244              "payment_identifier": {
245                "type": "string",
246                "description": "Payment sub payment mode identifier."
247              },
248              "transaction_timestamp": {
249                "type": [
250                  "string",
251                  "null"
252                ],
253                "description": "Refund transaction unix timestamp."
254              }
255            }
256          }
257        },
258        "forward_shipment_id": {
259          "type": [
260            "string",
261            "null"
262          ],
263          "description": "This is the shipment id."
264        }
265      }
266    }
267  }
268}
Payload Example
1{
2  "application_id": "5ead6538e2926050503b37cb",
3  "company_id": 334,
4  "contains": [
5    "merchant_order_id",
6    "forward_shipment_id",
7    "merchant_refund_id",
8    "journey_type",
9    "payment_status",
10    "order_id",
11    "refund_information"
12  ],
13  "event": {
14    "category": "application",
15    "created_timestamp": 1709545478238,
16    "id": "QNFQau1VoVbPdUotE6X2+iPltm5PdEPTlRm0Rjg25kI=",
17    "name": "refund",
18    "trace_id": [],
19    "type": "refund_pending",
20    "version": "1"
21  },
22  "payload": {
23    "forward_shipment_id": "17084085671641719614",
24    "journey_type": "RETURN",
25    "merchant_order_id": "FY65D43EF60E2A7E64A7",
26    "merchant_refund_id": "17086147149151382697",
27    "order_id": "FY65D43EF60E2A7E64A7",
28    "payment_status": "refund_pending",
29    "refund_information": [
30      {
31        "amount": 24493,
32        "collect_by": "fynd",
33        "meta": {
34          "id": null,
35          "logo_url": {
36            "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png",
37            "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/2qRUOzyNu-cod.png"
38          },
39          "mode": "",
40          "payment_id": "FY65D43EF60E2A7E64A7"
41        },
42        "mode": "COD",
43        "name": "COD",
44        "refund_by": "fynd",
45        "refund_details": {
46          "amount": 24493,
47          "bag_id": "17086147149151382697",
48          "error_traceback": null,
49          "journey_type": "RETURN",
50          "merchant_refund_id": "17086147149151382697",
51          "message": "None",
52          "payment_status": "refund_pending",
53          "payout_details": {
54            "account_holder": "rajendra mohanty",
55            "account_no": "XXXX-XXXX-5326",
56            "address": "dummy data",
57            "bank_name": "ICICI Bank",
58            "beneficiary_id": "5kA7BC/2323==",
59            "branch_name": "PUNE AUNDH NAGRAS ROAD",
60            "comment": "return",
61            "email": "test@example.com",
62            "ifsc_code": "232332",
63            "mobile": "1111111111"
64          },
65          "ref": null,
66          "status": "refund_pending",
67          "success": false,
68          "transaction_id": null,
69          "unique_request_id": null
70        }
71      }
72    ]
73  }
74}

Return config

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

Events
application/return_config/update/v1
# This event is triggered when return_config is created/updated

application/return_config/update/v1

This event is triggered when return_config is created/updated

Payload
Properties
application_id
array|string
Application/sales channel ID for which this event is triggered
company_id
integer
Company ID for which this event is triggered
contains
array of string
This array will have all the keys present at root level of 'payload' object
event
object
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level or any other level
Enum
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
Properties
return_config
object
Details of the return configuration that has been created or updated.
Properties
created_by
object
Required
Properties
username
string
Required
Username of the user who created the configuration.
user_id
string
Required
User ID of the user who created the configuration.
modified_by
object
Required
Properties
username
string
Required
Username of the user who last modified the configuration.
user_id
string
Required
User ID of the user who last modified the configuration.
return_config_level
string
Required
The level at which the return configuration is applied
Enum
app_id
string
Required
ID of the application in which the return configuration is created.
modified_on
string
| date-time
Required
Timestamp of the last modification.
category_count
integer
Required
Number of categories mapped under the Application.
company_id
integer
Required
ID of the company to which the return configuration belongs.
Payload Schema JSON
1{
2  "type": "object",
3  "description": "Event emitted when a Return Config is created/updated",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "Company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "enum": [
38            "global",
39            "click",
40            "application",
41            "extension",
42            "company"
43          ],
44          "description": "Category of the event. If it is at sales channel level or company level or any other level"
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds"
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event"
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace_id for Fynd Platform services",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event. e.g. create/update/delete"
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "properties": {
78        "return_config": {
79          "type": "object",
80          "description": "Details of the return configuration that has been created or updated.",
81          "properties": {
82            "created_by": {
83              "type": "object",
84              "properties": {
85                "username": {
86                  "type": "string",
87                  "description": "Username of the user who created the configuration."
88                },
89                "user_id": {
90                  "type": "string",
91                  "description": "User ID of the user who created the configuration."
92                }
93              },
94              "required": [
95                "username",
96                "user_id"
97              ]
98            },
99            "modified_by": {
100              "type": "object",
101              "properties": {
102                "username": {
103                  "type": "string",
104                  "description": "Username of the user who last modified the configuration."
105                },
106                "user_id": {
107                  "type": "string",
108                  "description": "User ID of the user who last modified the configuration."
109                }
110              },
111              "required": [
112                "username",
113                "user_id"
114              ]
115            },
116            "return_config_level": {
117              "type": "string",
118              "enum": [
119                "category",
120                "product",
121                "no-return"
122              ],
123              "description": "The level at which the return configuration is applied"
124            },
125            "app_id": {
126              "type": "string",
127              "description": "ID of the application in which the return configuration is created."
128            },
129            "modified_on": {
130              "type": "string",
131              "format": "date-time",
132              "description": "Timestamp of the last modification."
133            },
134            "category_count": {
135              "type": "integer",
136              "description": "Number of categories mapped under the Application."
137            },
138            "company_id": {
139              "type": "integer",
140              "description": "ID of the company to which the return configuration belongs."
141            }
142          },
143          "required": [
144            "created_by",
145            "modified_by",
146            "return_config_level",
147            "app_id",
148            "modified_on",
149            "category_count",
150            "company_id"
151          ]
152        }
153      }
154    }
155  }
156}
Payload Example
1{
2  "payload": {
3    "return_config": {
4      "created_by": {
5        "username": "test_example_com_12345",
6        "user_id": "d48583e0b34c93299a86fba4"
7      },
8      "modified_by": {
9        "username": "test_example_com_12345",
10        "user_id": "d48583e0b34c93299a86fba4"
11      },
12      "return_config_level": "product",
13      "app_id": "668e76839b4b84c705f4cd16",
14      "modified_on": "2024-07-11T04:31:50.963072",
15      "category_count": 0,
16      "company_id": 4
17    }
18  },
19  "meta": {
20    "trace_id": [
21      "silverbolt.7e363340-3f3e-11ef-bba3-fa3a2703c0c6"
22    ],
23    "created_timestamp": 1720672310977,
24    "service": {
25      "name": "silverbolt"
26    },
27    "company_id": 4,
28    "application_id": "668e76839b4b84c705f4cd16",
29    "event": {
30      "name": "return-config",
31      "type": "update",
32      "version": "1"
33    }
34  }
35}

Return config

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

Events
application/return_config_categories/update/v1
# This event is triggered when return config categories are created/updated
application/return_config_categories/delete/v1
# This event is triggered when return config categories are deleted

application/return_config_categories/update/v1

This event is triggered when return config categories are created/updated

Payload
Properties
application_id
array|string
Application/sales channel ID for which this event is triggered
company_id
integer
Company ID for which this event is triggered
contains
array of string
This array will have all the keys present at root level of 'payload' object
event
object
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level or any other level
Enum
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
Properties
return_config_categories
array of object
An array of return configuration categories that have been created, updated, or deleted.
Array of Properties
app_id
string
Required
ID of the application in which the return configuration is created.
logo
string
Required
URL of the logo image.
category_id
integer
Required
ID of the category.
name
string
Required
Name of the return configuration category.
return_config
object
Required
Details of the return policy, including time duration, returnable status, and time unit.
Properties
time
integer
Required
Time duration for the return policy.
returnable
boolean
Required
Flag indicating if the item is returnable.
unit
string
Required
Unit of time for the return policy.
Enum
Payload Schema JSON
1{
2  "type": "object",
3  "description": "Event emitted when Return Config categories are created/updated",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "Company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "enum": [
38            "global",
39            "click",
40            "application",
41            "extension",
42            "company"
43          ],
44          "description": "Category of the event. If it is at sales channel level or company level or any other level"
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds"
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event"
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "Internal trace_id for Fynd Platform services",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event. e.g. create/update/delete"
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "properties": {
78        "return_config_categories": {
79          "type": "array",
80          "description": "An array of return configuration categories that have been created, updated, or deleted.",
81          "items": {
82            "type": "object",
83            "properties": {
84              "app_id": {
85                "type": "string",
86                "description": "ID of the application in which the return configuration is created."
87              },
88              "logo": {
89                "type": "string",
90                "description": "URL of the logo image."
91              },
92              "category_id": {
93                "type": "integer",
94                "description": "ID of the category."
95              },
96              "name": {
97                "type": "string",
98                "description": "Name of the return configuration category."
99              },
100              "return_config": {
101                "type": "object",
102                "description": "Details of the return policy, including time duration, returnable status, and time unit.",
103                "properties": {
104                  "time": {
105                    "type": "integer",
106                    "description": "Time duration for the return policy."
107                  },
108                  "returnable": {
109                    "type": "boolean",
110                    "description": "Flag indicating if the item is returnable."
111                  },
112                  "unit": {
113                    "type": "string",
114                    "enum": [
115                      "days",
116                      "hours"
117                    ],
118                    "description": "Unit of time for the return policy."
119                  }
120                },
121                "required": [
122                  "time",
123                  "returnable",
124                  "unit"
125                ]
126              }
127            },
128            "required": [
129              "app_id",
130              "logo",
131              "category_id",
132              "name",
133              "return_config"
134            ]
135          }
136        }
137      }
138    }
139  }
140}
Payload Example
1{
2  "payload": {
3    "return_config_categories": [
4      {
5        "app_id": "668e76839b4b84c705f4cd16",
6        "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/vsm194/test/general/free/original/sampleJPG.jpg",
7        "category_id": 30,
8        "name": "Fashion",
9        "return_config": {
10          "time": 5,
11          "returnable": true,
12          "unit": "days"
13        }
14      },
15      {
16        "app_id": "668e76839b4b84c705f4cd16",
17        "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/vsm194/test/general/free/original/sampleJPG.jpg",
18        "category_id": 45,
19        "name": "Kids",
20        "return_config": {
21          "time": 5,
22          "returnable": true,
23          "unit": "days"
24        }
25      }
26    ]
27  },
28  "meta": {
29    "trace_id": [
30      "silverbolt.25a2aee0-3f41-11ef-bba3-fa3a2703c0c6"
31    ],
32    "created_timestamp": 1720673450861,
33    "service": {
34      "name": "silverbolt"
35    },
36    "company_id": 4,
37    "application_id": "668e76839b4b84c705f4cd16",
38    "event": {
39      "name": "return-config-categories",
40      "type": "update",
41      "version": "1"
42    }
43  }
44}

application/return_config_categories/delete/v1

This event is triggered when return config categories are deleted

Payload
Properties
application_id
array|string
Application/sales channel ID for which this event is triggered
company_id
integer
company ID for which this event is triggered
contains
array of string
This array will have all the keys present at root level of 'payload' object
event
object
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level or any other level
Enum
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
Properties
return_config_categories
array of integer
Required
IDs of the return configuration categories that have been deleted.
Payload Schema JSON
1{
2  "type": "object",
3  "description": "Event emitted when Return Config categories are deleted",
4  "properties": {
5    "application_id": {
6      "type": [
7        "array",
8        "string"
9      ],
10      "description": "Application/sales channel ID for which this event is triggered"
11    },
12    "company_id": {
13      "type": "integer",
14      "description": "company ID for which this event is triggered"
15    },
16    "contains": {
17      "type": "array",
18      "description": "This array will have all the keys present at root level of 'payload' object",
19      "items": {
20        "type": "string"
21      }
22    },
23    "event": {
24      "type": "object",
25      "required": [
26        "category",
27        "created_timestamp",
28        "id",
29        "name",
30        "trace_id",
31        "type",
32        "version"
33      ],
34      "properties": {
35        "category": {
36          "type": "string",
37          "enum": [
38            "global",
39            "click",
40            "application",
41            "extension",
42            "company"
43          ],
44          "description": "Category of the event. If it is at sales channel level or company level or any other level"
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "Event generation timestamp in epoch milliseconds"
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event"
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "internal trace_id for Fynd Platform services",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event. e.g. create/update/delete"
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "properties": {
78        "return_config_categories": {
79          "type": "array",
80          "items": {
81            "type": "integer"
82          },
83          "description": "IDs of the return configuration categories that have been deleted."
84        }
85      },
86      "required": [
87        "return_config_categories"
88      ]
89    }
90  }
91}
Payload Example
1{
2  "payload": {
3    "return_config_categories": [
4      30,
5      45
6    ]
7  },
8  "meta": {
9    "trace_id": [
10      "silverbolt.065dc036-3f43-11ef-bba3-fa3a2703c0c6"
11    ],
12    "created_timestamp": 1720674257394,
13    "service": {
14      "name": "silverbolt"
15    },
16    "company_id": 4,
17    "application_id": "668e76839b4b84c705f4cd16",
18    "event": {
19      "name": "return-config-categories",
20      "type": "delete",
21      "version": "1"
22    }
23  }
24}

Rma rule

This event is generated whenever any action is performed on an RMA rule. RMA (Return Merchandise Authorization) rules govern the conditions under which returns are processed, including quality checks, reasons for return, and associated actions.

Events
application/rma_rule/create/v1
# This event is triggered when an RMA rule is created. It includes all relevant information about the rule, such as its conditions, actions, and metadata.
application/rma_rule/update/v1
# This event is triggered when an RMA rule is updated. It includes all relevant information about the rule, such as its conditions, actions, and metadata.

application/rma_rule/create/v1

This event is triggered when an RMA rule is created. It includes all relevant information about the rule, such as its conditions, actions, and metadata.

Payload
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
"The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process."
Properties
entity_type
string
The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').
value
string
The value corresponding to the entity type, such as the specific department ID or category ID.
actions
object
"An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps."
Properties
reasons
array of object (Reason)
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Array of Reason
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
reasons
array of object (Reason)
List of sub-reasons that further detail the main reason.
Array of Reason
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
conditions
object
Conditions under which the rule is applied, such as specific departments or categories.
Properties
department
string
Department ID to which the rule is applicable.
l3
string
Level 3 category ID that the rule targets.
meta
object|null
Additional metadata related to the rule, which can include various key-value pairs.
rule_type
string
Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally.
Enum
is_active
boolean
Indicates whether the rule is currently active and being enforced.
updated_by
string
Identifier of the user who last modified the rule.
user_data
object|null
Additional data related to the user who interacted with the rule, such as preferences or settings.
config_id
string
Unique identifier for the configuration of the rule.
Payload Schema JSON
1{
2  "$ref": "#/components/schemas/rule_create_v1"
3}
Payload Example
1{}

application/rma_rule/update/v1

This event is triggered when an RMA rule is updated. It includes all relevant information about the rule, such as its conditions, actions, and metadata.

Payload
application_id
array|string
Required
Identifier(s) of the sales channel(s) associated with the event. The event is triggered for these specific sales channels.
company_id
integer
Required
Unique identifier for the company to which the event pertains.
contains
array of string
Required
Array containing all keys present at the root level of the 'payload' object. This helps in identifying the structure of the payload.
event
object
Required
Details of the event being produced, including metadata such as event category, timestamp, and traceability information.
Properties
category
string
Required
The category of the event, which defines its scope (e.g., company-wide or specific to an application).
Enum
created_timestamp
integer
Required
Timestamp indicating when the event was generated, represented in epoch milliseconds.
id
string
Required
Unique identifier for the event. This ID can be used by receivers to check if the event has already been processed.
name
string
Required
Human-readable name for the event.
trace_id
array of string
Required
Array of internal trace IDs used by Fynd Platform services to trace the event through various processes.
type
string
Required
Action associated with the event, such as creation or update of a rule.
Enum
version
string
Required
Version of the event format, useful for handling backward compatibility.
payload
object
Required
"The core content of the RMA rule update. This includes the rule's applicability, actions, reasons for return, conditions, and other metadata. It outlines how the rule should be enforced during the return process."
Properties
entity_type
string
The type of entity the rule applies to, such as a specific department or category (e.g., 'l3').
value
string
The value corresponding to the entity type, such as the specific department ID or category ID.
actions
object
"An object containing the reasons for return and corresponding actions. Each reason describes a scenario in which the rule applies and outlines the necessary checks or actions, such as quality control steps."
Properties
reasons
array of object (Reason)
A list of reasons associated with the action, detailing the circumstances under which the rule is applied.
Array of Reason
id
integer
Unique identifier for the reason.
display_name
string
Human-readable name for the reason.
qc_type
array of string
List of quality check types applicable to this reason. These checks ensure that the return process adheres to specific standards.
Enum
meta
object
Additional metadata related to the reason, which may include specific conditions or configurations.
is_active
boolean
Flag indicating whether this reason is currently active and applicable.
reasons
array of object (Reason)
List of sub-reasons that further detail the main reason.
Array of Reason
question_set
array of object
Set of questions associated with this reason, used to gather additional information necessary for the return process.
Array of Properties
id
integer
Unique identifier for the question.
display_name
string
Text of the question presented to the user.
qc_enabled
boolean
Indicates whether quality checks are required for the rule.
is_deleted
boolean
Flag indicating whether the rule has been deleted.
conditions
object
Conditions under which the rule is applied, such as specific departments or categories.
Properties
department
string
Department ID to which the rule is applicable.
l3
string
Level 3 category ID that the rule targets.
meta
object|null
Additional metadata related to the rule, which can include various key-value pairs.
rule_type
string
Indicates whether the rule is a 'custom' rule specific to certain conditions, or a 'global' rule applied universally.
Enum
is_active
boolean
Indicates whether the rule is currently active and being enforced.
updated_by
string
Identifier of the user who last modified the rule.
user_data
object|null
Additional data related to the user who interacted with the rule, such as preferences or settings.
config_id
string
Unique identifier for the configuration of the rule.
Payload Schema JSON
1{
2  "$ref": "#/components/schemas/rule_update_v1"
3}
Payload Example
1{}

Seo

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

Events
application/seo/update/v1
# this event is triggered when seo is updated

application/seo/update/v1

this event is triggered when seo 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
seo
object
Required
Properties
__v
integer
Required
_id
string
Required
app
string
Required
sales channel ID to which the SEO is related
details
object
Required
SEO details containing the `title` and `description` that would show up on the web search results
Properties
title
string
Required
description
string
Required
createdAt
string
Required
updatedAt
string
Required
robots_txt
string
Required
Content of /robots.txt file
sitemap_enabled
boolean
Required
Shows whether the sitemap is enabled for exposing all the URLs of the website to web crawlers/bots
custom_meta_tags
array of Undefined Type
Required
List of custom meta tags that are injected in HTML and used by crawlers/bots
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        "seo"
78      ],
79      "properties": {
80        "seo": {
81          "type": "object",
82          "required": [
83            "details",
84            "robots_txt",
85            "sitemap_enabled",
86            "_id",
87            "custom_meta_tags",
88            "app",
89            "createdAt",
90            "updatedAt",
91            "__v"
92          ],
93          "properties": {
94            "__v": {
95              "type": "integer"
96            },
97            "_id": {
98              "type": "string"
99            },
100            "app": {
101              "type": "string",
102              "description": "sales channel ID to which the SEO is related"
103            },
104            "details": {
105              "type": "object",
106              "description": "SEO details containing the `title` and `description` that would show up on the web search results",
107              "required": [
108                "title",
109                "description"
110              ],
111              "properties": {
112                "title": {
113                  "type": "string"
114                },
115                "description": {
116                  "type": "string"
117                }
118              }
119            },
120            "createdAt": {
121              "type": "string"
122            },
123            "updatedAt": {
124              "type": "string"
125            },
126            "robots_txt": {
127              "type": "string",
128              "description": "Content of /robots.txt file"
129            },
130            "sitemap_enabled": {
131              "type": "boolean",
132              "description": "Shows whether the sitemap is enabled for exposing all the URLs of the website to web crawlers/bots"
133            },
134            "custom_meta_tags": {
135              "type": "array",
136              "description": "List of custom meta tags that are injected in HTML and used by crawlers/bots",
137              "items": [
138                {
139                  "type": "object",
140                  "required": [
141                    "name",
142                    "content",
143                    "_id"
144                  ],
145                  "properties": {
146                    "_id": {
147                      "type": "string"
148                    },
149                    "name": {
150                      "type": "string"
151                    },
152                    "content": {
153                      "type": "string"
154                    }
155                  }
156                }
157              ]
158            }
159          }
160        }
161      }
162    }
163  }
164}
Payload Example
1{
2  "event": {
3    "id": "rOcs838XXrj5ef6LoJkfu9y3TTW25tDekAsleAA4Eck=",
4    "name": "seo",
5    "type": "update",
6    "version": "1",
7    "category": "application",
8    "trace_id": [
9      "convex.f4009557-4cb2-46c2-b8f8-769aaf8e8855"
10    ],
11    "created_timestamp": 1661319161914
12  },
13  "payload": {
14    "seo": {
15      "details": {
16        "title": "A.projeKt by Asmita Kala",
17        "description": "Contemporary Indian wear for women. \nContact: +91 8888888888"
18      },
19      "robots_txt": "User-agent: *\nDisallow: /dashboard/\nDisallow: /order/\nDisallow: /address_book/\nDisallow: /return/\nDisallow: /wishlist/\nDisallow: /cart/\nDisallow: /checkout/\nDisallow: /thankyou/\n\nSitemap:https://www.aprojekt.in/sitemap.xml",
20      "sitemap_enabled": true,
21      "_id": "60a24494eac74ae12d1a6551",
22      "app": "5f79bf6d3a35c3670c134b34",
23      "custom_meta_tags": [
24        {
25          "name": "ahref domain verification",
26          "content": "<meta name=\"ahrefs-site-verification\" content=\"8fd0bc49d8b5e677c269c63c354380428d5bef1d6f9ae62f455ba058ad8b4d01\">\n",
27          "_id": "62f654988c4facdbf76e24a2"
28        }
29      ],
30      "createdAt": "2021-05-17T10:25:24.386Z",
31      "updatedAt": "2022-08-17T09:12:17.075Z",
32      "__v": 1
33    }
34  },
35  "contains": [
36    "seo"
37  ],
38  "company_id": 2,
39  "application_id": "000000000000000000000001"
40}

Shipment

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

Events
application/shipment/create/v1
# this event is triggered when shipment is created
application/shipment/data_update/v1
# this event is triggered when shipment is data_updated
application/shipment/update/v1
# this event is triggered when shipment is updated

application/shipment/create/v1

this event is triggered when shipment 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
Event object that is being produced
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 produced by the OMS
Properties
shipment
object
Required
Shipment related details
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
entity_type
string
Required
Type of entity - bag, shipment
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
The unique identifier associated with the bag
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Details of the applied promotions
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Shipment weight
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
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      "description": "Event object that is being produced",
32      "required": [
33        "category",
34        "created_timestamp",
35        "id",
36        "name",
37        "trace_id",
38        "type",
39        "version"
40      ],
41      "properties": {
42        "category": {
43          "type": "string",
44          "description": "category of the event. If it is at sales channel level or company level"
45        },
46        "created_timestamp": {
47          "type": "integer",
48          "description": "event generation timestamp in epoch milliseconds"
49        },
50        "id": {
51          "type": "string",
52          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
53        },
54        "name": {
55          "type": "string",
56          "description": "Name of the event"
57        },
58        "trace_id": {
59          "type": "array",
60          "description": "internal trace_id for Fynd Platform services",
61          "items": {
62            "type": "string"
63          }
64        },
65        "type": {
66          "type": "string",
67          "description": "Type/Action of the event. e.g. create/update/delete"
68        },
69        "version": {
70          "type": "string",
71          "description": "Version of the event."
72        }
73      }
74    },
75    "payload": {
76      "type": "object",
77      "description": "Payload produced by the OMS",
78      "properties": {
79        "shipment": {
80          "type": "object",
81          "description": "Shipment related details",
82          "properties": {
83            "status": {
84              "type": "string",
85              "description": "Webhook shipment status, i.e., either create or update"
86            },
87            "shipment_status": {
88              "type": "object",
89              "description": "Status of the shipment indicating its current stage",
90              "properties": {
91                "created_at": {
92                  "type": "string",
93                  "description": "Shipment status created timestamp"
94                },
95                "created_ts": {
96                  "type": "string",
97                  "description": "Shipment status created timestamp"
98                },
99                "id": {
100                  "type": "number",
101                  "description": "Unique identifier associated with the shipment's status object"
102                },
103                "updated_ts": {
104                  "type": "string",
105                  "description": "Shipment status updated timestamp"
106                },
107                "bag_list": {
108                  "type": "array",
109                  "description": "List of Bag ids transitioned in this shipment's status",
110                  "items": {
111                    "type": "string"
112                  }
113                },
114                "shipment_id": {
115                  "type": "string",
116                  "description": "Unique shipment no. that is auto-generated"
117                },
118                "status": {
119                  "type": "string",
120                  "description": "Shipment's operational status"
121                },
122                "current_shipment_status": {
123                  "type": "string",
124                  "description": "Current shipment's status; it can be financial, logistics or operational"
125                },
126                "status_created_at": {
127                  "type": "string"
128                }
129              },
130              "required": [
131                "created_at",
132                "created_ts",
133                "id",
134                "updated_ts",
135                "bag_list",
136                "shipment_id",
137                "status",
138                "current_shipment_status",
139                "status_created_at"
140              ]
141            },
142            "application_id": {
143              "type": "string",
144              "description": "ID of the sales channel to which the shipment belongs"
145            },
146            "shipment_id": {
147              "type": "string",
148              "description": "Unique shipment no. that is auto-generated"
149            },
150            "company_id": {
151              "type": "number",
152              "description": "ID of the company fulfilling the shipment"
153            },
154            "app_company_id": {
155              "type": [
156                "number",
157                "null",
158                "string"
159              ],
160              "description": "ID of the company from which order was placed"
161            },
162            "order_id": {
163              "type": "string",
164              "description": "Unique ID of order in which the shipment is present"
165            },
166            "merchant_id": {
167              "type": "string",
168              "description": "Unique merchant id"
169            },
170            "user": {
171              "type": "object",
172              "description": "Purchaser's details such as name, last name, mobile no. and email",
173              "properties": {
174                "email": {
175                  "type": [
176                    "string",
177                    "null"
178                  ],
179                  "description": "Email address of the purchaser user"
180                },
181                "id": {
182                  "type": [
183                    "number",
184                    "null"
185                  ],
186                  "description": "Unique identifier for the purchaser user within the system"
187                },
188                "gender": {
189                  "type": [
190                    "null",
191                    "string"
192                  ],
193                  "description": "Gender of the purchaser user (e.g., male, female, other)"
194                },
195                "first_name": {
196                  "type": "string",
197                  "description": "First name of the purchaser user"
198                },
199                "external_customer_id": {
200                  "type": [
201                    "string",
202                    "null"
203                  ],
204                  "description": "External identifier associated with the purchaser user in another system"
205                },
206                "mobile": {
207                  "type": [
208                    "string",
209                    "null"
210                  ],
211                  "description": "Mobile phone number of the purchaser user"
212                },
213                "last_name": {
214                  "type": "string",
215                  "description": "Last name of the purchaser user"
216                },
217                "mongo_user_id": {
218                  "type": [
219                    "string",
220                    "null"
221                  ],
222                  "description": "User's object ID in mongodb collection"
223                },
224                "user_oid": {
225                  "type": [
226                    "string",
227                    "null"
228                  ],
229                  "description": "User Object ID assigned within the system"
230                },
231                "country_phone_code": {
232                  "type": [
233                    "string",
234                    "null"
235                  ],
236                  "description": "Country phone code associated with the purchaser user's mobile number"
237                },
238                "is_anonymous_user": {
239                  "type": "boolean",
240                  "description": "Flag indicating whether the user is anonymous"
241                }
242              }
243            },
244            "delivery_address": {
245              "type": "object",
246              "description": "Address where the shipment is to be delivered",
247              "properties": {
248                "area": {
249                  "type": "string",
250                  "description": "A string specifying the locality or area associated with the address"
251                },
252                "city": {
253                  "type": "string",
254                  "description": "A string denoting the city or municipality of the address"
255                },
256                "name": {
257                  "type": "string",
258                  "description": "A string representing the recipient's name or the organization name associated with the address"
259                },
260                "email": {
261                  "type": "string",
262                  "description": "Email of the recipient associated with the delivery address"
263                },
264                "phone": {
265                  "type": "string",
266                  "description": "Mobile phone number of recipient associated with the delivery address"
267                },
268                "state": {
269                  "type": "string",
270                  "description": "A string indicating the state or province of the delivery address"
271                },
272                "address": {
273                  "type": "string",
274                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
275                },
276                "country": {
277                  "type": "string",
278                  "description": "A string indicating the country of the address"
279                },
280                "pincode": {
281                  "type": "string",
282                  "description": "A string indicating the postal code or PIN code of the address area"
283                },
284                "user_id": {
285                  "type": [
286                    "number",
287                    "null"
288                  ],
289                  "description": "Unique identifier for the fulfilling user within the system"
290                },
291                "version": {
292                  "type": "string",
293                  "description": "Address version, to be deprecated"
294                },
295                "address1": {
296                  "type": "string",
297                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
298                },
299                "address2": {
300                  "type": "string",
301                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
302                },
303                "landmark": {
304                  "type": "string",
305                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
306                },
307                "latitude": {
308                  "type": [
309                    "number",
310                    "string"
311                  ],
312                  "description": "The latitude of the address"
313                },
314                "area_code": {
315                  "type": "string",
316                  "x-not-enum": true,
317                  "description": "Area code of the address"
318                },
319                "last_name": {
320                  "type": "string",
321                  "description": "Last name of the recipient associated with the delivery address"
322                },
323                "longitude": {
324                  "type": [
325                    "number",
326                    "string"
327                  ],
328                  "description": "The longitude of the address"
329                },
330                "created_at": {
331                  "type": "string",
332                  "format": "date-time",
333                  "description": "Date and time when the delivery address was created"
334                },
335                "first_name": {
336                  "type": "string",
337                  "description": "First name of the recipient associated with the delivery address"
338                },
339                "updated_at": {
340                  "type": "string",
341                  "format": "date-time",
342                  "description": "Date and time when the delivery address was last updated"
343                },
344                "address_type": {
345                  "type": "string",
346                  "x-not-enum": true,
347                  "description": "Type of address (e.g., home, office, registered)"
348                },
349                "geo_location": {
350                  "required": [],
351                  "description": "Geographic coordinates (latitude and longitude) of the delivery address",
352                  "type": "object",
353                  "properties": {
354                    "latitude": {
355                      "type": [
356                        "number",
357                        "string"
358                      ],
359                      "description": "The latitude of the geolocation"
360                    },
361                    "longitude": {
362                      "type": [
363                        "number",
364                        "string"
365                      ],
366                      "description": "The longitude of the geolocation"
367                    }
368                  }
369                },
370                "area_code_slug": {
371                  "type": "string",
372                  "description": "Unique identifier or slug for the area code associated with the address"
373                },
374                "contact_person": {
375                  "type": "string",
376                  "description": "Name of the contact person associated with the delivery address"
377                },
378                "display_address": {
379                  "type": "string",
380                  "description": "Formatted display version of the delivery address"
381                },
382                "address_category": {
383                  "type": "string",
384                  "x-not-enum": true,
385                  "description": "Category or classification of the delivery address"
386                },
387                "country_iso_code": {
388                  "type": "string",
389                  "x-not-enum": true,
390                  "description": "ISO code representing the country of the delivery address"
391                },
392                "country_phone_code": {
393                  "type": [
394                    "string",
395                    "null"
396                  ],
397                  "x-not-enum": true,
398                  "description": "Phone code for the country of the delivery address"
399                }
400              }
401            },
402            "billing_address": {
403              "type": "object",
404              "description": "Address by which the invoice is created",
405              "properties": {
406                "area": {
407                  "type": "string",
408                  "description": "A string specifying the locality or area associated with the address"
409                },
410                "city": {
411                  "type": "string",
412                  "description": "A string denoting the city or municipality of the address"
413                },
414                "name": {
415                  "type": "string",
416                  "description": "A string representing the billing user's name or the organization name associated with the address"
417                },
418                "email": {
419                  "type": "string",
420                  "description": "Email address associated with the billing address user"
421                },
422                "phone": {
423                  "type": "string",
424                  "description": "Phone number associated with the billing address user"
425                },
426                "state": {
427                  "type": "string",
428                  "description": "A string indicating the state or province of the billing address"
429                },
430                "address": {
431                  "type": "string",
432                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
433                },
434                "country": {
435                  "type": "string",
436                  "description": "A string indicating the country of the address"
437                },
438                "pincode": {
439                  "type": "string",
440                  "description": "A string indicating the postal code or PIN code of the address area"
441                },
442                "version": {
443                  "type": "string",
444                  "description": "Address version, to be deprecated"
445                },
446                "address1": {
447                  "type": "string",
448                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
449                },
450                "address2": {
451                  "type": "string",
452                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
453                },
454                "landmark": {
455                  "type": "string",
456                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
457                },
458                "latitude": {
459                  "type": [
460                    "number",
461                    "string"
462                  ],
463                  "description": "The latitude of the address"
464                },
465                "area_code": {
466                  "type": "string",
467                  "x-not-enum": true,
468                  "description": "Area code of the address"
469                },
470                "last_name": {
471                  "type": "string",
472                  "description": "Last name of the individual associated with the billing address"
473                },
474                "longitude": {
475                  "type": [
476                    "number",
477                    "string"
478                  ],
479                  "description": "The longitude of the address"
480                },
481                "created_at": {
482                  "type": "string",
483                  "format": "date-time",
484                  "description": "Date and time when the billing address was created"
485                },
486                "first_name": {
487                  "type": "string",
488                  "description": "First name of the individual associated with the billing address"
489                },
490                "updated_at": {
491                  "type": "string",
492                  "format": "date-time",
493                  "description": "Date and time when the billing address was last updated"
494                },
495                "address_type": {
496                  "type": "string",
497                  "x-not-enum": true,
498                  "description": "Type of address (e.g., home, office, registered)"
499                },
500                "geo_location": {
501                  "required": [],
502                  "description": "Geographic coordinates (latitude and longitude) of the billing address",
503                  "type": "object",
504                  "properties": {
505                    "latitude": {
506                      "type": [
507                        "number",
508                        "string"
509                      ],
510                      "description": "The latitude of the geolocation"
511                    },
512                    "longitude": {
513                      "type": [
514                        "number",
515                        "string"
516                      ],
517                      "description": "The longitude of the geolocation"
518                    }
519                  }
520                },
521                "area_code_slug": {
522                  "type": "string",
523                  "description": "Unique identifier or slug for the area code associated with the address"
524                },
525                "contact_person": {
526                  "type": "string",
527                  "description": "Name of the contact person associated with the billing address"
528                },
529                "display_address": {
530                  "type": "string",
531                  "description": "Formatted display version of the billing address"
532                },
533                "address_category": {
534                  "type": "string",
535                  "x-not-enum": true,
536                  "description": "Category or classification of the delivery address"
537                },
538                "country_iso_code": {
539                  "type": "string",
540                  "x-not-enum": true,
541                  "description": "ISO code representing the country of the delivery address"
542                },
543                "country_phone_code": {
544                  "type": [
545                    "string",
546                    "null"
547                  ],
548                  "x-not-enum": true,
549                  "description": "Phone code for the country of the delivery address"
550                }
551              }
552            },
553            "delivery_partner_details": {
554              "type": "object",
555              "description": "Delivery Partner details",
556              "properties": {
557                "id": {
558                  "type": [
559                    "string",
560                    "number",
561                    "null"
562                  ],
563                  "description": "Unique identifier for the delivery partner"
564                },
565                "name": {
566                  "type": [
567                    "string",
568                    "null"
569                  ],
570                  "description": "Name of the delivery partner"
571                },
572                "awb_no": {
573                  "type": [
574                    "string",
575                    "null"
576                  ],
577                  "description": "Airway Bill (AWB) number associated with the delivery"
578                },
579                "eway_bill_id": {
580                  "type": [
581                    "string",
582                    "null"
583                  ],
584                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
585                },
586                "track_url": {
587                  "type": [
588                    "string",
589                    "null"
590                  ],
591                  "description": "URL to track the delivery status or shipment details"
592                },
593                "gst_tag": {
594                  "type": [
595                    "string",
596                    "null"
597                  ],
598                  "description": "GST tag of the shipment"
599                },
600                "extension_id": {
601                  "type": [
602                    "string",
603                    "null"
604                  ],
605                  "description": "Unique Identifier of Courier partner Extension"
606                },
607                "scheme_id": {
608                  "type": [
609                    "string",
610                    "null"
611                  ],
612                  "description": "Unique identifier of a Courier partner scheme"
613                },
614                "courier_partner_slug": {
615                  "type": [
616                    "string",
617                    "null"
618                  ],
619                  "description": "Unique identifier containing extension_id and scheme_id"
620                }
621              },
622              "required": [
623                "id",
624                "name",
625                "awb_no",
626                "eway_bill_id",
627                "track_url",
628                "gst_tag",
629                "extension_id",
630                "scheme_id",
631                "courier_partner_slug"
632              ]
633            },
634            "bags": {
635              "type": "array",
636              "description": "Details of all the products/articles in a shipment",
637              "items": {
638                "type": "object",
639                "properties": {
640                  "financial_breakup": {
641                    "type": "array",
642                    "description": "Financial breakup of an item",
643                    "items": {
644                      "type": "object",
645                      "properties": {
646                        "brand_calculated_amount": {
647                          "type": "number",
648                          "description": "Effective selling price  - Brand's additional discounts"
649                        },
650                        "discount": {
651                          "type": "number",
652                          "description": "The total amount discounted from the original MRP/actual price"
653                        },
654                        "gst_fee": {
655                          "type": "number",
656                          "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
657                        },
658                        "gst_tax_percentage": {
659                          "type": "number",
660                          "description": "The percentage rate of GST applied to a product or service"
661                        },
662                        "gst_tag": {
663                          "type": [
664                            "string",
665                            "null"
666                          ],
667                          "description": "Type of GST applied - IGST, CGST, SGST"
668                        },
669                        "hsn_code": {
670                          "type": [
671                            "string",
672                            "null"
673                          ],
674                          "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
675                        },
676                        "identifiers": {
677                          "type": "object",
678                          "description": "Product identifiers",
679                          "properties": {
680                            "sku_code": {
681                              "type": "string",
682                              "description": "SKU code of the product"
683                            }
684                          }
685                        },
686                        "price_marked": {
687                          "type": "number",
688                          "description": "The indicated price or value assigned to an item before any discounts or adjustments"
689                        },
690                        "tax_collected_at_source": {
691                          "type": "number",
692                          "description": "The tax amount collected at the source of income or transaction"
693                        },
694                        "tcs_percentage": {
695                          "type": "number",
696                          "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
697                        },
698                        "total_units": {
699                          "type": "number",
700                          "description": "Total number of units of the item"
701                        },
702                        "value_of_good": {
703                          "type": "number",
704                          "description": "Effective selling price - Product GST Amount"
705                        },
706                        "item_name": {
707                          "type": "string",
708                          "description": "The name of the item being referenced"
709                        },
710                        "size": {
711                          "type": "string",
712                          "description": "The physical dimensions or specifications of the item, indicating its size or measurements"
713                        }
714                      },
715                      "required": [
716                        "brand_calculated_amount",
717                        "discount",
718                        "gst_fee",
719                        "gst_tax_percentage",
720                        "gst_tag",
721                        "hsn_code",
722                        "identifiers",
723                        "price_marked",
724                        "tax_collected_at_source",
725                        "tcs_percentage",
726                        "total_units",
727                        "value_of_good",
728                        "item_name",
729                        "size"
730                      ]
731                    }
732                  },
733                  "entity_type": {
734                    "type": "string",
735                    "description": "Type of entity - bag, shipment"
736                  },
737                  "item": {
738                    "type": "object",
739                    "description": "Item details",
740                    "properties": {
741                      "l3_category_name": {
742                        "type": "string",
743                        "description": "The name of the level 3 category to which the item belongs"
744                      },
745                      "l1_category_id": {
746                        "type": "number",
747                        "description": "ID representing the level 2 category classification of the item"
748                      },
749                      "code": {
750                        "type": "string",
751                        "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"
752                      },
753                      "branch_url": {
754                        "type": [
755                          "null",
756                          "string"
757                        ],
758                        "description": "Branch URL"
759                      },
760                      "l2_category": {
761                        "type": "array",
762                        "items": {
763                          "type": "string",
764                          "x-not-enum": true,
765                          "description": "The name of the level 2 category to which the item belongs"
766                        }
767                      },
768                      "l3_category": {
769                        "type": "number",
770                        "x-not-enum": true,
771                        "description": "ID representing the level 3 category classification of the item"
772                      },
773                      "last_updated_at": {
774                        "type": "string",
775                        "format": "date-time",
776                        "description": "Timestamp when the item was last updated"
777                      },
778                      "id": {
779                        "type": "number",
780                        "description": "ID of the item that is being referred"
781                      },
782                      "name": {
783                        "type": "string",
784                        "description": "The name of the item being referenced"
785                      },
786                      "can_return": {
787                        "type": "boolean",
788                        "description": "Flag indicating if the item is eligible for return"
789                      },
790                      "webstore_product_url": {
791                        "type": [
792                          "null",
793                          "string"
794                        ],
795                        "description": "Product URL"
796                      },
797                      "gender": {
798                        "type": [
799                          "null",
800                          "string"
801                        ],
802                        "description": "Gender associated with an item"
803                      },
804                      "l2_category_id": {
805                        "type": "number",
806                        "description": "ID representing the level 2 category classification of the item"
807                      },
808                      "color": {
809                        "type": [
810                          "null",
811                          "string"
812                        ],
813                        "description": "Color associated with and item"
814                      },
815                      "slug_key": {
816                        "type": "string",
817                        "description": "Automatically generated unique slug of the item"
818                      },
819                      "can_cancel": {
820                        "type": "boolean",
821                        "description": "Flag indicating if the item is eligible for cancellation"
822                      },
823                      "attributes": {
824                        "type": "object",
825                        "description": "An object containing descriptive properties of the item",
826                        "properties": {
827                          "name": {
828                            "type": "string",
829                            "description": "The name or title of the item"
830                          },
831                          "color": {
832                            "type": "string",
833                            "description": "The color description of the item"
834                          },
835                          "essential": {
836                            "type": "string",
837                            "description": "Indicates whether the item is considered essential"
838                          },
839                          "brand_name": {
840                            "type": "string",
841                            "description": "The brand name of the item"
842                          },
843                          "primary_color": {
844                            "type": "string",
845                            "description": "The primary color of the item"
846                          },
847                          "primary_color_hex": {
848                            "type": "string",
849                            "description": "The hexadecimal code representing the primary color"
850                          },
851                          "primary-colour-hex-code": {
852                            "type": "string",
853                            "description": "The hexadecimal code representing the primary color"
854                          },
855                          "media": {
856                            "type": "array",
857                            "description": "An array containing media files associated with the item",
858                            "items": {
859                              "type": "object"
860                            }
861                          }
862                        }
863                      },
864                      "brand_id": {
865                        "type": "number",
866                        "description": "The unique identifier associated with the brand of the item"
867                      },
868                      "brand": {
869                        "type": "string",
870                        "description": "The brand or manufacturer of the item"
871                      },
872                      "l1_category": {
873                        "type": "array",
874                        "items": {
875                          "type": "string",
876                          "x-not-enum": true,
877                          "description": "The name of the level 1 category to which the item belongs"
878                        }
879                      },
880                      "department_id": {
881                        "type": "number",
882                        "description": "The unique identifier representing the department or category to which the item belongs"
883                      },
884                      "size": {
885                        "type": "string",
886                        "description": "The size or dimensions of the item"
887                      },
888                      "image": {
889                        "type": "array",
890                        "items": {
891                          "type": "string",
892                          "description": "Url of the item's image"
893                        }
894                      }
895                    }
896                  },
897                  "brand": {
898                    "type": "object",
899                    "description": "Brand's information",
900                    "properties": {
901                      "credit_note_allowed": {
902                        "type": "boolean",
903                        "description": "If a credit note ID needs to be generated by the system"
904                      },
905                      "created_on": {
906                        "type": "string",
907                        "description": "Date and time when the brand was registered or created"
908                      },
909                      "id": {
910                        "type": "number",
911                        "description": "Unique identifier assigned to the brand for reference and identification"
912                      },
913                      "logo": {
914                        "type": "string",
915                        "description": "Visual representation or emblem associated with the brand"
916                      },
917                      "modified_on": {
918                        "type": "string",
919                        "description": "Date and time of the most recent update or modification to the brand's information"
920                      },
921                      "is_virtual_invoice": {
922                        "type": "boolean",
923                        "description": "If invoice ID needs to be generated by the system"
924                      },
925                      "brand_name": {
926                        "type": "string",
927                        "description": "Name or title of the brand used for identification and representation"
928                      }
929                    },
930                    "required": [
931                      "credit_note_allowed",
932                      "created_on",
933                      "id",
934                      "logo",
935                      "modified_on",
936                      "is_virtual_invoice",
937                      "brand_name"
938                    ]
939                  },
940                  "bag_id": {
941                    "type": "number",
942                    "description": "The unique identifier associated with the bag"
943                  },
944                  "article": {
945                    "type": "object",
946                    "description": "Details of the article",
947                    "properties": {
948                      "identifiers": {
949                        "type": "object",
950                        "description": "Product identifiers",
951                        "properties": {
952                          "sku_code": {
953                            "type": "string"
954                          }
955                        }
956                      },
957                      "esp_modified": {
958                        "type": [
959                          "string",
960                          "boolean"
961                        ],
962                        "description": "Flag representing if effective selling price has been modified"
963                      },
964                      "size": {
965                        "type": "string",
966                        "description": "The physical dimensions or specifications of the article, indicating its size or measurements"
967                      },
968                      "code": {
969                        "type": "string",
970                        "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"
971                      },
972                      "set": {
973                        "description": "Details of the set article containing size distribution",
974                        "type": "object",
975                        "properties": {
976                          "quantity": {
977                            "type": "integer",
978                            "description": "Number of units present"
979                          },
980                          "size_distribution": {
981                            "type": "object",
982                            "description": "Object indicating the distribution of size and quantity of a set article",
983                            "properties": {
984                              "sizes": {
985                                "type": "array",
986                                "description": "Array indicating size wise units present in a set article",
987                                "items": {
988                                  "type": "object",
989                                  "description": "Object indicating the size and quantity distribution of a set article",
990                                  "properties": {
991                                    "pieces": {
992                                      "type": "integer",
993                                      "description": "Number of units of a particular size"
994                                    },
995                                    "size": {
996                                      "type": "string",
997                                      "description": "Size of the article"
998                                    }
999                                  }
1000                                }
1001                              }
1002                            }
1003                          }
1004                        }
1005                      },
1006                      "is_set": {
1007                        "type": [
1008                          "string",
1009                          "boolean"
1010                        ],
1011                        "description": "A boolean indicating whether the article is a set"
1012                      },
1013                      "seller_identifier": {
1014                        "type": "string",
1015                        "description": "Seller's identifier of the article"
1016                      },
1017                      "return_config": {
1018                        "type": "object",
1019                        "description": "Return configuration details of the article",
1020                        "properties": {
1021                          "time": {
1022                            "type": "number",
1023                            "description": "Number indicating number of hours or days"
1024                          },
1025                          "unit": {
1026                            "type": "string",
1027                            "description": "String indicating the unit of the time, eg. days, hours"
1028                          },
1029                          "returnable": {
1030                            "type": "boolean",
1031                            "description": "Flag indicating whether product is returnable or not"
1032                          }
1033                        },
1034                        "required": [
1035                          "time",
1036                          "unit",
1037                          "returnable"
1038                        ]
1039                      },
1040                      "_id": {
1041                        "type": "string",
1042                        "description": "DB generated ID of the article"
1043                      },
1044                      "uid": {
1045                        "type": "string",
1046                        "description": "UID of the article"
1047                      },
1048                      "child_details": {
1049                        "type": [
1050                          "object",
1051                          "array"
1052                        ],
1053                        "description": "Child article details if any",
1054                        "properties": {},
1055                        "required": []
1056                      },
1057                      "dimensions": {
1058                        "description": "The dimension object of the article/item",
1059                        "required": [],
1060                        "type": "object",
1061                        "properties": {
1062                          "height": {
1063                            "type": [
1064                              "number",
1065                              "null"
1066                            ],
1067                            "description": "The height of the product"
1068                          },
1069                          "width": {
1070                            "type": [
1071                              "number",
1072                              "null"
1073                            ],
1074                            "description": "The width of the product"
1075                          },
1076                          "is_default": {
1077                            "type": [
1078                              "boolean",
1079                              "null"
1080                            ],
1081                            "description": "Whether the dimension is the default one or not"
1082                          },
1083                          "unit": {
1084                            "type": [
1085                              "string",
1086                              "null"
1087                            ],
1088                            "description": "The unit of dimension"
1089                          },
1090                          "length": {
1091                            "type": [
1092                              "number",
1093                              "null"
1094                            ],
1095                            "description": "The length of the product"
1096                          }
1097                        }
1098                      },
1099                      "weight": {
1100                        "required": [],
1101                        "type": "object",
1102                        "description": "Object containing weight details of item/article",
1103                        "properties": {
1104                          "unit": {
1105                            "type": "string",
1106                            "description": "The unit of weight",
1107                            "example": "kg"
1108                          },
1109                          "shipping": {
1110                            "type": "number",
1111                            "description": "The shipping weight of the product",
1112                            "example": 1.5
1113                          },
1114                          "is_default": {
1115                            "type": "boolean",
1116                            "description": "Whether the weight is the default one or not",
1117                            "example": true
1118                          }
1119                        }
1120                      },
1121                      "currency": {
1122                        "type": "object",
1123                        "description": "Order currency details",
1124                        "properties": {
1125                          "code": {
1126                            "type": "string",
1127                            "description": "Currency code"
1128                          },
1129                          "rate": {
1130                            "type": "number",
1131                            "description": "The conversion rate value"
1132                          }
1133                        },
1134                        "required": []
1135                      },
1136                      "expiration_date": {}
1137                    },
1138                    "required": [
1139                      "identifiers",
1140                      "esp_modified",
1141                      "size",
1142                      "code",
1143                      "set",
1144                      "is_set",
1145                      "seller_identifier",
1146                      "return_config",
1147                      "_id",
1148                      "uid",
1149                      "child_details",
1150                      "dimensions",
1151                      "weight",
1152                      "currency",
1153                      "expiration_date"
1154                    ]
1155                  },
1156                  "current_operational_status": {
1157                    "type": "object",
1158                    "properties": {
1159                      "created_at": {
1160                        "type": "string",
1161                        "format": "date-time",
1162                        "description": "Date and time when the shipment status record was created"
1163                      },
1164                      "created_ts": {
1165                        "type": "string",
1166                        "description": "Timestamp indicating the exact time when the shipment status record was created"
1167                      },
1168                      "id": {
1169                        "type": "number",
1170                        "description": "Unique identifier for the shipment status record"
1171                      },
1172                      "kafka_sync": {
1173                        "type": "boolean",
1174                        "description": "Flag indicating whether the shipment status update has been sync with Kafka"
1175                      },
1176                      "updated_ts": {
1177                        "type": "string",
1178                        "description": "Timestamp indicating the last time the shipment status record was updated"
1179                      },
1180                      "updated_at": {
1181                        "type": "string",
1182                        "format": "date-time",
1183                        "description": "Date and time of the most recent update to the shipment status record"
1184                      },
1185                      "delivery_partner_id": {
1186                        "type": [
1187                          "integer",
1188                          "null"
1189                        ],
1190                        "description": "Unique identifier of delivery partner"
1191                      },
1192                      "shipment_id": {
1193                        "type": "string",
1194                        "description": "Unique shipment no. that is auto-generated"
1195                      },
1196                      "store_id": {
1197                        "type": "number",
1198                        "description": "ID of the fulfilling store of the shipment"
1199                      },
1200                      "status": {
1201                        "type": "string",
1202                        "description": "Current operational status of the shipment"
1203                      },
1204                      "bag_id": {
1205                        "type": "number",
1206                        "description": "The unique identifier associated with the bag"
1207                      },
1208                      "state_id": {
1209                        "type": "number",
1210                        "description": "The unique identifier associated with the state"
1211                      },
1212                      "state_type": {
1213                        "type": "string",
1214                        "enum": [
1215                          "operational",
1216                          "logistics",
1217                          "financial"
1218                        ],
1219                        "description": "Type of the state - operational, logistics, financial"
1220                      },
1221                      "delivery_awb_number": {
1222                        "type": [
1223                          "string",
1224                          "null"
1225                        ],
1226                        "description": "Airway Bill (AWB) number associated with the delivery"
1227                      },
1228                      "bag_state_mapper": {
1229                        "type": "object",
1230                        "description": "Object representing properties of the state",
1231                        "properties": {
1232                          "journey_type": {
1233                            "type": [
1234                              "string",
1235                              "null"
1236                            ],
1237                            "enum": [
1238                              "forward",
1239                              "return"
1240                            ],
1241                            "description": "Journey type can be forward or return"
1242                          },
1243                          "app_display_name": {
1244                            "type": "string",
1245                            "description": "The display name of a shipment status as it appears on the sale channel's website"
1246                          },
1247                          "state_type": {
1248                            "type": "string",
1249                            "enum": [
1250                              "operational",
1251                              "logistics",
1252                              "financial"
1253                            ],
1254                            "description": "Type of the state - operational, logistics, financial"
1255                          },
1256                          "app_state_name": {
1257                            "type": "string",
1258                            "description": "The slug of a shipment status from the sale channel's front"
1259                          },
1260                          "name": {
1261                            "type": "string",
1262                            "description": "The slug of a shipment status from the platform's front"
1263                          },
1264                          "app_facing": {
1265                            "type": "boolean",
1266                            "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1267                          },
1268                          "id": {
1269                            "type": "number",
1270                            "description": "The unique identifier associated with the state"
1271                          },
1272                          "display_name": {
1273                            "type": "string",
1274                            "description": "The display name of a shipment status as it appears on the platform"
1275                          },
1276                          "is_active": {
1277                            "type": "boolean",
1278                            "description": "A boolean flag indicating whether a state is active or not"
1279                          }
1280                        },
1281                        "required": [
1282                          "journey_type",
1283                          "app_display_name",
1284                          "state_type",
1285                          "app_state_name",
1286                          "name",
1287                          "app_facing",
1288                          "id",
1289                          "display_name",
1290                          "is_active"
1291                        ]
1292                      },
1293                      "reasons": {
1294                        "type": "array",
1295                        "items": {
1296                          "type": "object",
1297                          "properties": {
1298                            "slug": {
1299                              "type": "string",
1300                              "description": "System generated slug"
1301                            },
1302                            "display_name": {
1303                              "type": "string",
1304                              "description": "Text that is displayed on the application front"
1305                            },
1306                            "id": {
1307                              "type": "integer",
1308                              "description": "System generated ID of the reason object"
1309                            },
1310                            "state": {
1311                              "type": [
1312                                "integer",
1313                                "string"
1314                              ],
1315                              "description": "State associated with the reason"
1316                            },
1317                            "text": {
1318                              "type": "string",
1319                              "description": "Reason text"
1320                            },
1321                            "quantity": {
1322                              "type": "integer",
1323                              "description": "No of quantity that is being cancelled"
1324                            },
1325                            "inventory_flag": {
1326                              "type": "boolean",
1327                              "description": "Inventory depletion action to be taken or not"
1328                            }
1329                          }
1330                        },
1331                        "description": "Reasons associated with the current shipment's status"
1332                      },
1333                      "action_user": {
1334                        "description": "Details of the user who initiated the change in the shipment's status",
1335                        "required": [],
1336                        "type": "object",
1337                        "properties": {
1338                          "title": {
1339                            "type": "string",
1340                            "description": "The title of the user eg. Staff, Admin",
1341                            "example": "Staff"
1342                          },
1343                          "user_id": {
1344                            "type": "string",
1345                            "description": "System generated ID associated with the user",
1346                            "example": "23546659"
1347                          },
1348                          "user_name": {
1349                            "type": "string",
1350                            "description": "System generated username associated with the user",
1351                            "example": "65967faf620ff7c9db513d9c"
1352                          },
1353                          "order_role": {
1354                            "type": "string",
1355                            "description": "Order role associated with the user eg. company_operation, store_manager",
1356                            "example": "full_access"
1357                          },
1358                          "employee_code": {
1359                            "type": "string",
1360                            "x-not-enum": true,
1361                            "description": "Employee code associated with the user",
1362                            "example": "EM-102"
1363                          }
1364                        }
1365                      }
1366                    },
1367                    "required": [
1368                      "created_at",
1369                      "created_ts",
1370                      "id",
1371                      "kafka_sync",
1372                      "updated_ts",
1373                      "updated_at",
1374                      "delivery_partner_id",
1375                      "shipment_id",
1376                      "store_id",
1377                      "status",
1378                      "bag_id",
1379                      "state_id",
1380                      "state_type",
1381                      "delivery_awb_number",
1382                      "bag_state_mapper",
1383                      "reasons",
1384                      "action_user"
1385                    ]
1386                  },
1387                  "affiliate_bag_details": {
1388                    "type": "object",
1389                    "description": "Object containing external bag details like external order id, external bag id",
1390                    "properties": {
1391                      "affiliate_bag_id": {
1392                        "type": "string",
1393                        "description": "External bag id"
1394                      },
1395                      "affiliate_order_id": {
1396                        "type": "string",
1397                        "description": "External order id"
1398                      }
1399                    },
1400                    "required": [
1401                      "affiliate_bag_id",
1402                      "affiliate_order_id"
1403                    ]
1404                  },
1405                  "payment_methods": {
1406                    "type": "object",
1407                    "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
1408                  },
1409                  "quantity": {
1410                    "type": "number",
1411                    "description": "Total quantity of the article present in the bag."
1412                  },
1413                  "prices": {
1414                    "type": "object",
1415                    "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
1416                    "properties": {
1417                      "price_effective": {
1418                        "type": "number",
1419                        "description": "MRP - Initial Seller provided discount"
1420                      },
1421                      "discount": {
1422                        "type": "number",
1423                        "description": "The total amount discounted from the original MRP/actual price"
1424                      },
1425                      "amount_paid": {
1426                        "type": "number",
1427                        "description": "Amount paid by the customer"
1428                      },
1429                      "coupon_effective_discount": {
1430                        "type": "number",
1431                        "description": "Coupon provided by brand or seller"
1432                      },
1433                      "delivery_charge": {
1434                        "type": "number",
1435                        "description": "The fee associated with the delivery service for transporting the item to its destination"
1436                      },
1437                      "fynd_credits": {
1438                        "type": "number",
1439                        "description": "Credits provided by Fynd"
1440                      },
1441                      "cod_charges": {
1442                        "type": "number",
1443                        "description": "The fee associated with the COD order"
1444                      },
1445                      "refund_credit": {
1446                        "type": "number",
1447                        "description": "Refund credits provided to the customer"
1448                      },
1449                      "cashback": {
1450                        "type": "number",
1451                        "description": "Cashback points"
1452                      },
1453                      "refund_amount": {
1454                        "type": "number",
1455                        "description": "Amount to be refunded on cancellation and return"
1456                      },
1457                      "added_to_fynd_cash": {
1458                        "type": "boolean",
1459                        "description": "Flag indicating whether fynd cash has been used"
1460                      },
1461                      "cashback_applied": {
1462                        "type": "number",
1463                        "description": "Cashback applied on the order"
1464                      },
1465                      "gst_tax_percentage": {
1466                        "type": "number",
1467                        "description": "The percentage rate of GST applied to a product or service"
1468                      },
1469                      "value_of_good": {
1470                        "type": "number",
1471                        "description": "Effective selling price - Product GST Amount"
1472                      },
1473                      "price_marked": {
1474                        "type": "number",
1475                        "description": "The indicated price or value assigned to an item before any discounts or adjustments"
1476                      },
1477                      "transfer_price": {
1478                        "type": "number",
1479                        "description": "article"
1480                      },
1481                      "brand_calculated_amount": {
1482                        "type": "number",
1483                        "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"
1484                      },
1485                      "tax_collected_at_source": {
1486                        "type": "number",
1487                        "description": "The tax amount collected at the source of income or transaction"
1488                      },
1489                      "tcs_percentage": {
1490                        "type": "number",
1491                        "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
1492                      },
1493                      "promotion_effective_discount": {
1494                        "type": "number",
1495                        "description": "Effective promotion discount including promotions given by seller and Platform"
1496                      },
1497                      "gift_price": {
1498                        "type": "number",
1499                        "description": "Gift card amount used"
1500                      },
1501                      "coupon_value": {
1502                        "type": "number",
1503                        "description": "Stores the coupon value as shown in the cart"
1504                      },
1505                      "seller_promotion_effective_discount": {
1506                        "type": "number",
1507                        "description": "Promotion discount given by the seller"
1508                      },
1509                      "fynd_promotion_effective_discount": {
1510                        "type": "number",
1511                        "description": "Promotion discount given by Platform/fynd"
1512                      },
1513                      "amount_paid_roundoff": {
1514                        "type": "number",
1515                        "description": "Amount paid rounded off"
1516                      }
1517                    },
1518                    "required": [
1519                      "price_effective",
1520                      "discount",
1521                      "amount_paid",
1522                      "coupon_effective_discount",
1523                      "delivery_charge",
1524                      "fynd_credits",
1525                      "cod_charges",
1526                      "refund_credit",
1527                      "cashback",
1528                      "refund_amount",
1529                      "added_to_fynd_cash",
1530                      "cashback_applied",
1531                      "gst_tax_percentage",
1532                      "value_of_good",
1533                      "price_marked",
1534                      "transfer_price",
1535                      "brand_calculated_amount",
1536                      "tax_collected_at_source",
1537                      "tcs_percentage",
1538                      "promotion_effective_discount",
1539                      "gift_price",
1540                      "coupon_value",
1541                      "seller_promotion_effective_discount",
1542                      "fynd_promotion_effective_discount",
1543                      "amount_paid_roundoff"
1544                    ]
1545                  },
1546                  "order_created": {
1547                    "type": "string",
1548                    "description": "Order creation timestamp"
1549                  },
1550                  "gst_details": {
1551                    "type": "object",
1552                    "description": "GST details associated with the bag",
1553                    "properties": {
1554                      "gstin_code": {
1555                        "type": [
1556                          "string",
1557                          "null"
1558                        ],
1559                        "x-not-enum": true,
1560                        "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
1561                      },
1562                      "gst_tag": {
1563                        "type": [
1564                          "string",
1565                          "null"
1566                        ],
1567                        "description": "Type of GST applied - IGST, CGST, SGST"
1568                      },
1569                      "hsn_code": {
1570                        "type": [
1571                          "string",
1572                          "null"
1573                        ],
1574                        "x-not-enum": true,
1575                        "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
1576                      },
1577                      "value_of_good": {
1578                        "type": "number",
1579                        "description": "Effective selling price - Product GST Amount"
1580                      },
1581                      "gst_tax_percentage": {
1582                        "type": "number",
1583                        "description": "The percentage rate of GST applied to a product or service"
1584                      },
1585                      "is_default_hsn_code": {
1586                        "type": "boolean"
1587                      },
1588                      "brand_calculated_amount": {
1589                        "type": "number",
1590                        "description": "Effective selling price  - Brand's additional discounts"
1591                      },
1592                      "tax_collected_at_source": {
1593                        "type": "number",
1594                        "description": "The tax amount collected at the source of income or transaction"
1595                      },
1596                      "hsn_code_id": {
1597                        "type": [
1598                          "string",
1599                          "null"
1600                        ],
1601                        "description": "The unique identifier associated with HSN code"
1602                      },
1603                      "gst_fee": {
1604                        "type": "number",
1605                        "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
1606                      },
1607                      "igst_tax_percentage": {
1608                        "type": "number",
1609                        "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"
1610                      },
1611                      "sgst_tax_percentage": {
1612                        "type": "number",
1613                        "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"
1614                      },
1615                      "cgst_tax_percentage": {
1616                        "type": "number",
1617                        "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"
1618                      },
1619                      "igst_gst_fee": {
1620                        "type": [
1621                          "string",
1622                          "number"
1623                        ],
1624                        "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"
1625                      },
1626                      "cgst_gst_fee": {
1627                        "type": "string",
1628                        "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"
1629                      },
1630                      "sgst_gst_fee": {
1631                        "type": "string",
1632                        "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"
1633                      }
1634                    },
1635                    "required": [
1636                      "gstin_code",
1637                      "gst_tag",
1638                      "hsn_code",
1639                      "value_of_good",
1640                      "gst_tax_percentage",
1641                      "is_default_hsn_code",
1642                      "brand_calculated_amount",
1643                      "tax_collected_at_source",
1644                      "hsn_code_id",
1645                      "gst_fee",
1646                      "igst_tax_percentage",
1647                      "sgst_tax_percentage",
1648                      "cgst_tax_percentage",
1649                      "igst_gst_fee",
1650                      "cgst_gst_fee",
1651                      "sgst_gst_fee"
1652                    ]
1653                  },
1654                  "line_number": {
1655                    "type": "number",
1656                    "description": "Unique identifier associated with each bag in a shipment"
1657                  },
1658                  "applied_promos": {
1659                    "type": "array",
1660                    "description": "Details of the applied promotions",
1661                    "items": {
1662                      "type": "object",
1663                      "properties": {
1664                        "promo_id": {
1665                          "type": "string",
1666                          "description": "Promotion id"
1667                        },
1668                        "buy_rules": {
1669                          "description": "Buy rules for promotions",
1670                          "type": "array",
1671                          "items": {
1672                            "type": "object",
1673                            "properties": {
1674                              "item_criteria": {
1675                                "type": "object",
1676                                "description": "Item criteria of promotion"
1677                              },
1678                              "cart_conditions": {
1679                                "type": "object",
1680                                "description": "Cart conditions details for promotion"
1681                              }
1682                            }
1683                          }
1684                        },
1685                        "offer_text": {
1686                          "type": "string",
1687                          "description": "Offer text of current promotion"
1688                        },
1689                        "promotion_group": {
1690                          "type": "string",
1691                          "description": "Promotion group for the promotion"
1692                        },
1693                        "mrp_promotion": {
1694                          "type": "boolean",
1695                          "description": "If applied promotion is applied on product MRP or ESP"
1696                        },
1697                        "promotion_name": {
1698                          "type": "string",
1699                          "description": "Promotion name of current promotion"
1700                        },
1701                        "amount": {
1702                          "type": "number",
1703                          "description": "Per unit discount amount applied with current promotion"
1704                        },
1705                        "discount_rules": {
1706                          "description": "Discount rules for promotions",
1707                          "type": "array",
1708                          "items": {
1709                            "type": "object",
1710                            "properties": {
1711                              "matched_buy_rules": {
1712                                "type": "array",
1713                                "description": "Matched buy rules for promotion",
1714                                "items": {
1715                                  "type": "string"
1716                                }
1717                              },
1718                              "raw_offer": {
1719                                "type": "object",
1720                                "description": "raw offer details for promotion"
1721                              },
1722                              "offer": {
1723                                "type": "object",
1724                                "description": "offer for promotion"
1725                              },
1726                              "item_criteria": {
1727                                "type": "object",
1728                                "description": "Item criteria of promotion"
1729                              }
1730                            }
1731                          }
1732                        },
1733                        "ownership": {
1734                          "type": "object",
1735                          "description": "Ownership of promotion",
1736                          "properties": {
1737                            "payable_category": {
1738                              "type": "string",
1739                              "x-not-enum": true,
1740                              "description": "promo amount payable category"
1741                            },
1742                            "payable_by": {
1743                              "type": "string",
1744                              "description": "promo amount bearable party"
1745                            }
1746                          }
1747                        },
1748                        "article_quantity": {
1749                          "type": "integer",
1750                          "description": "Quantity of article on which promotion is applicable"
1751                        },
1752                        "applied_free_articles": {
1753                          "description": "Applied free article for free gift item promotions",
1754                          "type": "array",
1755                          "items": {
1756                            "type": "object",
1757                            "properties": {
1758                              "free_gift_item_details": {
1759                                "description": "Free gift items details",
1760                                "type": "object",
1761                                "properties": {
1762                                  "item_slug": {
1763                                    "type": "string",
1764                                    "description": "item slug"
1765                                  },
1766                                  "item_name": {
1767                                    "type": "string",
1768                                    "description": "Item name"
1769                                  },
1770                                  "item_price_details": {
1771                                    "type": "object",
1772                                    "description": "item price details"
1773                                  },
1774                                  "item_brand_name": {
1775                                    "type": "string",
1776                                    "description": "item brand name"
1777                                  },
1778                                  "item_id": {
1779                                    "type": "integer",
1780                                    "description": "Item id"
1781                                  },
1782                                  "item_images_url": {
1783                                    "type": "array",
1784                                    "description": "item images URL",
1785                                    "items": {
1786                                      "type": "string"
1787                                    }
1788                                  }
1789                                }
1790                              },
1791                              "parent_item_identifier": {
1792                                "type": "string",
1793                                "description": "Parent item identifier for free article"
1794                              },
1795                              "quantity": {
1796                                "type": "integer",
1797                                "description": "Free article quantity"
1798                              },
1799                              "article_id": {
1800                                "type": "string",
1801                                "description": "free article id"
1802                              }
1803                            }
1804                          }
1805                        },
1806                        "promotion_type": {
1807                          "type": "string",
1808                          "x-not-enum": true,
1809                          "description": "Promotion type of current promotion"
1810                        },
1811                        "meta": {
1812                          "type": "object",
1813                          "additionalProperties": true,
1814                          "description": "Meta object for extra data"
1815                        },
1816                        "code": {
1817                          "type": [
1818                            "string",
1819                            "null"
1820                          ],
1821                          "description": "Promotion code"
1822                        }
1823                      }
1824                    }
1825                  }
1826                },
1827                "required": [
1828                  "financial_breakup",
1829                  "entity_type",
1830                  "item",
1831                  "brand",
1832                  "bag_id",
1833                  "article",
1834                  "current_operational_status",
1835                  "affiliate_bag_details",
1836                  "payment_methods",
1837                  "quantity",
1838                  "prices",
1839                  "order_created",
1840                  "gst_details",
1841                  "line_number",
1842                  "applied_promos"
1843                ]
1844              }
1845            },
1846            "bag_status_history": {
1847              "type": "array",
1848              "description": "Records the changes in status for a bag, providing a timeline of events and transitions",
1849              "items": {
1850                "type": "object",
1851                "properties": {
1852                  "created_at": {
1853                    "type": "string",
1854                    "format": "date-time",
1855                    "description": "Date and time when the bag status history record was created."
1856                  },
1857                  "created_ts": {
1858                    "type": "string",
1859                    "description": "Timestamp indicating the exact time when the bag status history record was created"
1860                  },
1861                  "id": {
1862                    "type": "number",
1863                    "description": "Unique identifier for the bag status history record"
1864                  },
1865                  "kafka_sync": {
1866                    "type": "boolean",
1867                    "description": "Flag indicating whether the bag status history update has been sync with Kafka"
1868                  },
1869                  "updated_ts": {
1870                    "type": "string",
1871                    "description": "Timestamp indicating the last time the bag status history record was updated"
1872                  },
1873                  "updated_at": {
1874                    "format": "date-time",
1875                    "type": "string",
1876                    "description": "Date and time of the most recent update to the bag status history record"
1877                  },
1878                  "delivery_partner_id": {
1879                    "type": [
1880                      "integer",
1881                      "null"
1882                    ],
1883                    "description": "Unique identifier of delivery partner"
1884                  },
1885                  "shipment_id": {
1886                    "type": "string",
1887                    "description": "Unique shipment no. that is auto-generated"
1888                  },
1889                  "store_id": {
1890                    "type": "number",
1891                    "description": "Store id associated with the bag"
1892                  },
1893                  "status": {
1894                    "type": "string",
1895                    "description": "Webhook shipment status, i.e., either create or update"
1896                  },
1897                  "bag_id": {
1898                    "type": "number",
1899                    "description": "The unique identifier associated with the bag"
1900                  },
1901                  "state_id": {
1902                    "type": "number",
1903                    "description": "The unique identifier associated with the state"
1904                  },
1905                  "state_type": {
1906                    "type": "string",
1907                    "enum": [
1908                      "operational",
1909                      "logistics",
1910                      "financial"
1911                    ],
1912                    "description": "Type of the state - operational, logistics, financial"
1913                  },
1914                  "delivery_awb_number": {
1915                    "type": [
1916                      "string",
1917                      "null"
1918                    ],
1919                    "description": "Airway Bill (AWB) number associated with the delivery"
1920                  },
1921                  "bag_state_mapper": {
1922                    "type": "object",
1923                    "description": "Object representing properties of the state",
1924                    "properties": {
1925                      "journey_type": {
1926                        "type": [
1927                          "string",
1928                          "null"
1929                        ],
1930                        "enum": [
1931                          "forward",
1932                          "return"
1933                        ],
1934                        "description": "Journey type can be forward or return"
1935                      },
1936                      "app_display_name": {
1937                        "type": "string",
1938                        "description": "The display name of a shipment status as it appears on the sale channel's website"
1939                      },
1940                      "state_type": {
1941                        "type": "string",
1942                        "enum": [
1943                          "operational",
1944                          "logistics",
1945                          "financial"
1946                        ],
1947                        "description": "Type of the state - operational, logistics, financial"
1948                      },
1949                      "app_state_name": {
1950                        "type": "string",
1951                        "description": "The slug of a shipment status from the sale channel's front"
1952                      },
1953                      "name": {
1954                        "type": "string",
1955                        "description": "The slug of a shipment status from the platform's front"
1956                      },
1957                      "app_facing": {
1958                        "type": "boolean",
1959                        "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1960                      },
1961                      "id": {
1962                        "type": "number",
1963                        "description": "The unique identifier associated with the state"
1964                      },
1965                      "display_name": {
1966                        "type": "string",
1967                        "description": "The display name of a shipment status as it appears on the platform"
1968                      },
1969                      "is_active": {
1970                        "type": "boolean",
1971                        "description": "A boolean flag indicating whether a state is active or not"
1972                      }
1973                    },
1974                    "required": [
1975                      "journey_type",
1976                      "app_display_name",
1977                      "state_type",
1978                      "app_state_name",
1979                      "name",
1980                      "app_facing",
1981                      "id",
1982                      "display_name",
1983                      "is_active"
1984                    ]
1985                  },
1986                  "reasons": {
1987                    "type": "array",
1988                    "items": {
1989                      "type": "object",
1990                      "properties": {
1991                        "slug": {
1992                          "type": "string",
1993                          "description": "System generated slug"
1994                        },
1995                        "display_name": {
1996                          "type": "string",
1997                          "description": "Text that is displayed on the application front"
1998                        },
1999                        "id": {
2000                          "type": "integer",
2001                          "description": "System generated ID of the reason object"
2002                        },
2003                        "state": {
2004                          "type": [
2005                            "integer",
2006                            "string"
2007                          ],
2008                          "description": "State associated with the reason"
2009                        },
2010                        "text": {
2011                          "type": "string",
2012                          "description": "Reason text"
2013                        },
2014                        "quantity": {
2015                          "type": "integer",
2016                          "description": "No of quantity that is being cancelled"
2017                        },
2018                        "inventory_flag": {
2019                          "type": "boolean",
2020                          "description": "Inventory depletion action to be taken or not"
2021                        }
2022                      }
2023                    },
2024                    "description": "Reasons associated with the current shipment's status"
2025                  },
2026                  "action_user": {
2027                    "type": "object",
2028                    "properties": {
2029                      "title": {
2030                        "type": "string",
2031                        "description": "The title of the user eg. Staff, Admin",
2032                        "example": "Staff"
2033                      },
2034                      "user_id": {
2035                        "type": "string",
2036                        "description": "System generated ID associated with the user",
2037                        "example": "23546659"
2038                      },
2039                      "user_name": {
2040                        "type": "string",
2041                        "description": "System generated username associated with the user",
2042                        "example": "65967faf620ff7c9db513d9c"
2043                      },
2044                      "order_role": {
2045                        "type": "string",
2046                        "description": "Order role associated with the user eg. company_operation, store_manager",
2047                        "example": "full_access"
2048                      },
2049                      "employee_code": {
2050                        "type": "string",
2051                        "x-not-enum": true,
2052                        "description": "Employee code associated with the user",
2053                        "example": "EM-102"
2054                      }
2055                    },
2056                    "required": []
2057                  }
2058                },
2059                "required": [
2060                  "created_at",
2061                  "created_ts",
2062                  "id",
2063                  "kafka_sync",
2064                  "updated_ts",
2065                  "updated_at",
2066                  "delivery_partner_id",
2067                  "shipment_id",
2068                  "store_id",
2069                  "status",
2070                  "bag_id",
2071                  "state_id",
2072                  "state_type",
2073                  "delivery_awb_number",
2074                  "bag_state_mapper",
2075                  "reasons",
2076                  "action_user"
2077                ]
2078              }
2079            },
2080            "fulfilling_store": {
2081              "description": "Details of the store responsible for fulfilling the order",
2082              "type": "object",
2083              "properties": {
2084                "id": {
2085                  "type": "number",
2086                  "description": "Unique identifier for the store."
2087                },
2088                "code": {
2089                  "type": "string",
2090                  "description": "Alphanumeric code representing the store."
2091                },
2092                "name": {
2093                  "type": "string",
2094                  "description": "Name of the store."
2095                },
2096                "address": {
2097                  "type": "string",
2098                  "description": "Physical address of the store."
2099                },
2100                "state": {
2101                  "type": "string",
2102                  "description": "State where the store is located."
2103                },
2104                "city": {
2105                  "type": "string",
2106                  "description": "City where the store is located."
2107                },
2108                "pincode": {
2109                  "type": "string",
2110                  "description": "Postal code (pincode) of the store's location."
2111                },
2112                "country": {
2113                  "type": "string",
2114                  "description": "Country where the store is situated."
2115                },
2116                "phone": {
2117                  "type": "string",
2118                  "description": "Contact phone number for the store."
2119                },
2120                "fulfillment_channel": {
2121                  "type": "string",
2122                  "description": "Type of fulfillment channel used by the store."
2123                },
2124                "location_type": {
2125                  "type": "string",
2126                  "enum": [
2127                    "high_street",
2128                    "mall",
2129                    "store",
2130                    "warehouse"
2131                  ],
2132                  "description": "Type of location e.g., warehouse, high_street"
2133                },
2134                "company_id": {
2135                  "type": "number",
2136                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
2137                },
2138                "is_active": {
2139                  "type": "boolean",
2140                  "description": "Boolean indicating whether the store is currently active"
2141                },
2142                "tags": {
2143                  "type": "array",
2144                  "items": {
2145                    "type": "string"
2146                  },
2147                  "description": "Array of tags associated with the store"
2148                }
2149              },
2150              "required": [
2151                "id",
2152                "code",
2153                "name",
2154                "address",
2155                "state",
2156                "city",
2157                "pincode",
2158                "country",
2159                "phone",
2160                "fulfillment_channel",
2161                "location_type",
2162                "company_id",
2163                "is_active",
2164                "tags"
2165              ]
2166            },
2167            "prices": {
2168              "type": "object",
2169              "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
2170              "properties": {
2171                "amount_paid": {
2172                  "type": "number",
2173                  "description": "Amount paid by the customer"
2174                },
2175                "refund_amount": {
2176                  "type": "number",
2177                  "description": "Amount to be refunded on cancellation and return"
2178                },
2179                "price_marked": {
2180                  "type": "number",
2181                  "description": "The indicated price or value assigned to an item before any discounts or adjustments"
2182                },
2183                "cod_charges": {
2184                  "type": "number",
2185                  "description": "The fee associated with the COD order"
2186                },
2187                "discount": {
2188                  "type": "number",
2189                  "description": "The total amount discounted from the original MRP/actual price"
2190                },
2191                "cashback_applied": {
2192                  "type": "number",
2193                  "description": "Cashback applied on the order"
2194                },
2195                "delivery_charge": {
2196                  "type": "number",
2197                  "description": "The fee associated with the delivery service for transporting the item to its destination"
2198                },
2199                "fynd_credits": {
2200                  "type": "number",
2201                  "description": "Credits provided by Fynd"
2202                },
2203                "cashback": {
2204                  "type": "number",
2205                  "description": "Cashback points"
2206                },
2207                "price_effective": {
2208                  "type": "number",
2209                  "description": "MRP - Initial Seller provided discount"
2210                },
2211                "refund_credit": {
2212                  "type": "number",
2213                  "description": "Refund credits provided to the customer"
2214                },
2215                "value_of_good": {
2216                  "type": "number",
2217                  "description": "Effective selling price - Product GST Amount"
2218                },
2219                "coupon_value": {
2220                  "type": "number",
2221                  "description": "Stores the coupon value as shown in the cart"
2222                },
2223                "tax_collected_at_source": {
2224                  "type": "number",
2225                  "description": "The tax amount collected at the source of income or transaction"
2226                },
2227                "promotion_effective_discount": {
2228                  "type": "number",
2229                  "description": "Effective promotion discount including promotions given by seller and Platform"
2230                },
2231                "fynd_promotion_effective_discount": {
2232                  "type": "number",
2233                  "description": "Promotion discount given by Platform/fynd"
2234                },
2235                "seller_promotion_effective_discount": {
2236                  "type": "number",
2237                  "description": "Promotion discount given by the seller"
2238                },
2239                "cn_refund_amount": {
2240                  "type": "number",
2241                  "description": "Amount to be refunded through credit note"
2242                },
2243                "gift_price": {
2244                  "type": "number",
2245                  "description": "Gift card amount used"
2246                },
2247                "amount_paid_roundoff": {
2248                  "type": "number",
2249                  "description": "Amount paid rounded off"
2250                }
2251              },
2252              "required": [
2253                "amount_paid",
2254                "refund_amount",
2255                "price_marked",
2256                "cod_charges",
2257                "discount",
2258                "cashback_applied",
2259                "delivery_charge",
2260                "fynd_credits",
2261                "cashback",
2262                "price_effective",
2263                "refund_credit",
2264                "value_of_good",
2265                "coupon_value",
2266                "tax_collected_at_source",
2267                "promotion_effective_discount",
2268                "fynd_promotion_effective_discount",
2269                "seller_promotion_effective_discount",
2270                "cn_refund_amount",
2271                "gift_price"
2272              ]
2273            },
2274            "payments": {
2275              "type": "object",
2276              "description": "Object containing payment mode and payment breakup",
2277              "properties": {
2278                "id": {
2279                  "type": "number",
2280                  "description": "Unique identifier for the payment mode"
2281                },
2282                "mode": {
2283                  "type": "string",
2284                  "description": "Type or category of the payment mode (e.g., PP, COD)"
2285                },
2286                "logo": {
2287                  "type": "string",
2288                  "description": "URL or path to the logo/icon representing the payment mode"
2289                },
2290                "display_name": {
2291                  "type": "string",
2292                  "description": "Name or label used to display the payment mode"
2293                },
2294                "display_priority": {
2295                  "type": "number",
2296                  "description": "Priority order for displaying the payment mode"
2297                },
2298                "source": {
2299                  "type": "string",
2300                  "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"
2301                },
2302                "is_active": {
2303                  "type": "boolean",
2304                  "description": "Boolean indicating whether the payment mode is currently active"
2305                }
2306              },
2307              "required": [
2308                "id",
2309                "mode",
2310                "logo",
2311                "display_name",
2312                "display_priority",
2313                "source",
2314                "is_active"
2315              ]
2316            },
2317            "affiliate_details": {
2318              "type": "object",
2319              "description": "Application related details like config, order_id, shipment id",
2320              "properties": {
2321                "id": {
2322                  "type": [
2323                    "string",
2324                    "number"
2325                  ],
2326                  "description": "Identifier for the application, can be application_id or extension_id"
2327                },
2328                "affiliate_bag_id": {
2329                  "type": "string",
2330                  "description": "Identifier assigned by the application for the bag"
2331                },
2332                "affiliate_order_id": {
2333                  "type": "string",
2334                  "description": "Identifier of the order assigned by the application"
2335                },
2336                "company_affiliate_tag": {
2337                  "type": "string",
2338                  "description": "Tag associated with the bag from the application's company"
2339                },
2340                "affiliate_id": {
2341                  "type": "string",
2342                  "description": "Identifier for the application, can be application_id or extension_id"
2343                },
2344                "affiliate_shipment_id": {
2345                  "type": "string",
2346                  "description": "Identifier of the shipment assigned by the application"
2347                },
2348                "affiliate_store_id": {
2349                  "type": "string",
2350                  "description": "Identifier of the store assigned by the application"
2351                },
2352                "pdf_links": {
2353                  "type": "object",
2354                  "description": "PDF Links pushed by the application or extension",
2355                  "properties": {
2356                    "label_type": {
2357                      "type": "string",
2358                      "description": "Label type - external"
2359                    },
2360                    "invoice_type": {
2361                      "type": "string",
2362                      "description": "Invoice type - external"
2363                    },
2364                    "label": {
2365                      "type": "string",
2366                      "description": "Label URL provided by the application or extension"
2367                    },
2368                    "invoice": {
2369                      "type": "string",
2370                      "description": "Invoice URL provided by the application or extension"
2371                    }
2372                  },
2373                  "required": [
2374                    "label_type",
2375                    "invoice_type"
2376                  ]
2377                },
2378                "config": {
2379                  "type": "object",
2380                  "description": "Application configuration details",
2381                  "properties": {
2382                    "id": {
2383                      "type": [
2384                        "string",
2385                        "number"
2386                      ],
2387                      "description": "Identifier for the application, can be application_id or extension_id"
2388                    },
2389                    "name": {
2390                      "type": "string",
2391                      "description": "Application name"
2392                    },
2393                    "token": {
2394                      "type": [
2395                        "null",
2396                        "string"
2397                      ],
2398                      "description": "Application token - deprecated"
2399                    },
2400                    "dp_assignment": {
2401                      "type": "boolean",
2402                      "description": "Flag indicating whether auto DP assignment should happen from system"
2403                    },
2404                    "app_company_id": {
2405                      "type": [
2406                        "number",
2407                        "null",
2408                        "string"
2409                      ],
2410                      "description": "ID of the company from which order was placed"
2411                    },
2412                    "article_assignment": {
2413                      "description": "The article assignment settings",
2414                      "type": "object",
2415                      "properties": {
2416                        "strategy": {
2417                          "type": "string",
2418                          "enum": [
2419                            "optimal",
2420                            "low-price"
2421                          ]
2422                        },
2423                        "level": {
2424                          "type": "string",
2425                          "enum": [
2426                            "multi-companies",
2427                            "single-company",
2428                            "single-store"
2429                          ]
2430                        }
2431                      },
2432                      "required": []
2433                    },
2434                    "force_reassignment": {
2435                      "type": "boolean",
2436                      "description": "Indicates whether force reassignment is enabled"
2437                    },
2438                    "sales_channel_logo": {
2439                      "type": "string",
2440                      "description": "Logo URL of the application to which order belongs"
2441                    },
2442                    "ordering_channel_logo": {
2443                      "type": "string",
2444                      "description": "Logo URL of the ordering channel"
2445                    },
2446                    "post_order_reassignment": {
2447                      "type": "boolean",
2448                      "description": "Indicates whether post-order reassignment is enabled"
2449                    }
2450                  }
2451                }
2452              },
2453              "required": [
2454                "id",
2455                "affiliate_bag_id",
2456                "affiliate_order_id",
2457                "company_affiliate_tag",
2458                "affiliate_id",
2459                "affiliate_shipment_id",
2460                "affiliate_store_id",
2461                "pdf_links",
2462                "config"
2463              ]
2464            },
2465            "dp_details": {
2466              "type": "object",
2467              "description": "Delivery Partner details",
2468              "properties": {
2469                "id": {
2470                  "type": [
2471                    "string",
2472                    "number",
2473                    "null"
2474                  ],
2475                  "description": "Unique identifier for the delivery partner"
2476                },
2477                "name": {
2478                  "type": [
2479                    "string",
2480                    "null"
2481                  ],
2482                  "description": "Name of the delivery partner"
2483                },
2484                "awb_no": {
2485                  "type": [
2486                    "string",
2487                    "null"
2488                  ],
2489                  "description": "Airway Bill (AWB) number associated with the delivery"
2490                },
2491                "eway_bill_id": {
2492                  "type": [
2493                    "string",
2494                    "null"
2495                  ],
2496                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
2497                },
2498                "track_url": {
2499                  "type": [
2500                    "string",
2501                    "null"
2502                  ],
2503                  "description": "URL to track the delivery status or shipment details"
2504                },
2505                "gst_tag": {
2506                  "type": [
2507                    "string",
2508                    "null"
2509                  ],
2510                  "description": "GST tag of the shipment"
2511                },
2512                "extension_id": {
2513                  "type": [
2514                    "string",
2515                    "null"
2516                  ],
2517                  "description": "Unique Identifier of Courier partner Extension"
2518                },
2519                "scheme_id": {
2520                  "type": [
2521                    "string",
2522                    "null"
2523                  ],
2524                  "description": "Unique identifier of a Courier partner scheme"
2525                },
2526                "courier_partner_slug": {
2527                  "type": [
2528                    "string",
2529                    "null"
2530                  ],
2531                  "description": "Unique identifier containing extension_id and scheme_id"
2532                }
2533              },
2534              "required": [
2535                "id",
2536                "name",
2537                "awb_no",
2538                "eway_bill_id",
2539                "track_url",
2540                "gst_tag",
2541                "extension_id",
2542                "scheme_id",
2543                "courier_partner_slug"
2544              ]
2545            },
2546            "rto_address": {
2547              "type": "object",
2548              "description": "The address to which shipment should be delivered in case of RTO",
2549              "properties": {
2550                "company_id": {
2551                  "type": "number",
2552                  "description": "ID of the company fulfilling the shipment"
2553                },
2554                "id": {
2555                  "type": "number",
2556                  "description": "ID of the store where RTO should happen"
2557                },
2558                "name": {
2559                  "type": "string",
2560                  "description": "A string representing the store's name"
2561                },
2562                "store_address_json": {
2563                  "type": "object",
2564                  "description": "Store address details",
2565                  "properties": {
2566                    "version": {
2567                      "type": "string",
2568                      "description": "Address version, to be deprecated"
2569                    },
2570                    "contact_person": {
2571                      "type": "string",
2572                      "description": "Name of the contact person associated with the address"
2573                    },
2574                    "address": {
2575                      "type": "string",
2576                      "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
2577                    },
2578                    "address1": {
2579                      "type": "string",
2580                      "description": "\"A string representing the first line of the address, typically containing street or building information\""
2581                    },
2582                    "address2": {
2583                      "type": "string",
2584                      "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2585                    },
2586                    "name": {
2587                      "type": "string",
2588                      "description": "A string representing the store's name"
2589                    },
2590                    "area": {
2591                      "type": "string",
2592                      "description": "A string specifying the locality or area associated with the address"
2593                    },
2594                    "area_code": {
2595                      "type": "string",
2596                      "x-not-enum": true,
2597                      "description": "Area code of the address"
2598                    },
2599                    "area_code_slug": {
2600                      "type": "string",
2601                      "description": "Unique identifier or slug for the area code associated with the address"
2602                    },
2603                    "landmark": {
2604                      "type": "string",
2605                      "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
2606                    },
2607                    "city": {
2608                      "type": "string",
2609                      "description": "A string denoting the city or municipality of the address"
2610                    },
2611                    "state": {
2612                      "type": "string",
2613                      "description": "A string indicating the state or province of the address"
2614                    },
2615                    "country": {
2616                      "type": "string",
2617                      "description": "A string indicating the country of the address"
2618                    },
2619                    "pincode": {
2620                      "type": "string",
2621                      "description": "A string indicating the postal code or PIN code of the address area"
2622                    },
2623                    "longitude": {
2624                      "type": [
2625                        "number",
2626                        "string"
2627                      ],
2628                      "description": "The longitude of the address"
2629                    },
2630                    "sector": {
2631                      "type": "string",
2632                      "description": "A string specifying the sector or district of the address if applicable"
2633                    },
2634                    "latitude": {
2635                      "type": [
2636                        "number",
2637                        "string"
2638                      ],
2639                      "description": "The latitude of the address"
2640                    },
2641                    "phone": {
2642                      "type": "string",
2643                      "description": "Mobile phone number of recipient associated with the address"
2644                    },
2645                    "email": {
2646                      "type": "string",
2647                      "description": "Email of the recipient associated with the address"
2648                    },
2649                    "address_type": {
2650                      "type": "string",
2651                      "x-not-enum": true,
2652                      "description": "Type of address (e.g., home, office, registered)"
2653                    },
2654                    "address_category": {
2655                      "type": "string",
2656                      "x-not-enum": true,
2657                      "description": "Category or classification of the address"
2658                    },
2659                    "created_at": {
2660                      "type": "string",
2661                      "format": "date-time",
2662                      "description": "Date and time when the address was created"
2663                    },
2664                    "updated_at": {
2665                      "type": "string",
2666                      "format": "date-time",
2667                      "description": "Date and time when the address was last updated"
2668                    },
2669                    "country_phone_code": {
2670                      "type": [
2671                        "string",
2672                        "null"
2673                      ],
2674                      "x-not-enum": true,
2675                      "description": "Phone code for the country of the address"
2676                    },
2677                    "country_iso_code": {
2678                      "type": "string",
2679                      "x-not-enum": true,
2680                      "description": "ISO code representing the country of the address"
2681                    },
2682                    "country_code": {
2683                      "type": "string",
2684                      "x-not-enum": true,
2685                      "description": "ISO code representing the country of the address"
2686                    },
2687                    "display_address": {
2688                      "type": "string",
2689                      "description": "Formatted display version of the address"
2690                    }
2691                  }
2692                },
2693                "code": {
2694                  "type": "string",
2695                  "description": "Alphanumeric code representing the store"
2696                },
2697                "location_type": {
2698                  "type": "string",
2699                  "x-not-enum": true,
2700                  "description": "Type of location e.g., warehouse, high_street"
2701                },
2702                "address1": {
2703                  "type": "string",
2704                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
2705                },
2706                "address2": {
2707                  "type": "string",
2708                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2709                },
2710                "display_address": {
2711                  "type": "string",
2712                  "description": "Formatted display version of the address"
2713                },
2714                "city": {
2715                  "type": "string",
2716                  "description": "A string denoting the city or municipality of the address"
2717                },
2718                "state": {
2719                  "type": "string",
2720                  "description": "A string indicating the state or province of the address"
2721                },
2722                "sector": {
2723                  "type": "string",
2724                  "description": "A string specifying the sector or district of the address if applicable"
2725                },
2726                "country": {
2727                  "type": "string",
2728                  "description": "A string indicating the country of the address"
2729                },
2730                "pincode": {
2731                  "type": "string",
2732                  "description": "A string indicating the postal code or PIN code of the address area"
2733                },
2734                "store_email": {
2735                  "type": "string",
2736                  "description": "Email of the recipient associated with the store"
2737                },
2738                "contact_person": {
2739                  "type": "string",
2740                  "description": "Name of the contact person associated with the address"
2741                },
2742                "phone": {
2743                  "type": "string",
2744                  "description": "Mobile phone number of recipient associated with the address"
2745                }
2746              },
2747              "required": [
2748                "company_id",
2749                "id",
2750                "name",
2751                "store_address_json",
2752                "code",
2753                "location_type",
2754                "address1",
2755                "address2",
2756                "display_address",
2757                "city",
2758                "state",
2759                "sector",
2760                "country",
2761                "pincode",
2762                "store_email",
2763                "contact_person",
2764                "phone"
2765              ]
2766            },
2767            "weight": {
2768              "type": "object",
2769              "description": "Shipment weight",
2770              "properties": {
2771                "value": {
2772                  "type": "number"
2773                },
2774                "unit": {
2775                  "type": "string"
2776                }
2777              },
2778              "required": [
2779                "value",
2780                "unit"
2781              ]
2782            },
2783            "shipment_gst": {
2784              "type": "object",
2785              "description": "GST details associated with the shipment",
2786              "properties": {
2787                "value_of_good": {
2788                  "type": "number",
2789                  "description": "Effective selling price - Product GST Amount"
2790                },
2791                "gst_fee": {
2792                  "type": "number",
2793                  "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
2794                },
2795                "brand_calculated_amount": {
2796                  "type": "number",
2797                  "description": "Effective selling price  - Brand's additional discounts"
2798                },
2799                "tax_collected_at_source": {
2800                  "type": "number",
2801                  "description": "The tax amount collected at the source of income or transaction"
2802                },
2803                "gstin_code": {
2804                  "type": [
2805                    "string",
2806                    "null"
2807                  ],
2808                  "x-not-enum": true,
2809                  "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
2810                }
2811              },
2812              "required": [
2813                "value_of_good",
2814                "gst_fee",
2815                "brand_calculated_amount",
2816                "tax_collected_at_source",
2817                "gstin_code"
2818              ]
2819            },
2820            "store_invoice_id": {
2821              "type": [
2822                "string",
2823                "null"
2824              ],
2825              "description": "Invoice ID attached to the shipment"
2826            },
2827            "credit_note_id": {
2828              "type": [
2829                "string",
2830                "null"
2831              ],
2832              "description": "Credit Note ID attached to the shipment"
2833            },
2834            "order_created": {
2835              "type": "string",
2836              "description": "Order creation timestamp"
2837            },
2838            "payment_methods": {
2839              "type": "object",
2840              "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
2841            },
2842            "payment_info": {
2843              "type": "array",
2844              "description": "\"Array of object containing payment methods used for placing an order.\"",
2845              "items": {}
2846            },
2847            "order": {
2848              "type": "object",
2849              "description": "Order level details",
2850              "properties": {
2851                "ordering_channel": {
2852                  "type": "string",
2853                  "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
2854                },
2855                "ordering_source": {
2856                  "type": "string",
2857                  "nullable": true,
2858                  "description": "To uniquely identify the source through which order has been placed.",
2859                  "enum": [
2860                    "storefront",
2861                    "store_os_pos",
2862                    "kiosk",
2863                    "scan_go",
2864                    "smart_trolley",
2865                    "gofynd",
2866                    "uniket",
2867                    "marketplace",
2868                    "social_commerce",
2869                    "ondc",
2870                    "nexus"
2871                  ]
2872                },
2873                "affiliate_order_date": {
2874                  "type": [
2875                    "string",
2876                    "null"
2877                  ],
2878                  "format": "date-time",
2879                  "description": "Order creation timestamp at application/extension end"
2880                },
2881                "affiliate_order_id": {
2882                  "type": "string",
2883                  "description": "Identifier of the order assigned by the application"
2884                },
2885                "fynd_order_id": {
2886                  "type": "string",
2887                  "description": "System generated unique identifier of the order"
2888                },
2889                "mode_of_payment": {
2890                  "type": "string",
2891                  "description": "Unique identifier associated with the payment mode"
2892                },
2893                "source": {
2894                  "type": "string",
2895                  "description": "Ordering source eg. affiliate, fynd"
2896                },
2897                "total_order_value": {
2898                  "type": "number",
2899                  "description": "Total order value"
2900                },
2901                "collect_by": {
2902                  "type": "string",
2903                  "description": "Whomsoever collected the money"
2904                },
2905                "refund_by": {
2906                  "type": "string",
2907                  "description": "Whomsoever will refund the money"
2908                },
2909                "order_value": {
2910                  "type": "number",
2911                  "description": "Value of the order"
2912                }
2913              },
2914              "required": [
2915                "ordering_channel",
2916                "affiliate_order_date",
2917                "affiliate_order_id",
2918                "fynd_order_id",
2919                "mode_of_payment",
2920                "source",
2921                "total_order_value",
2922                "collect_by",
2923                "refund_by",
2924                "order_value"
2925              ]
2926            },
2927            "order_source": {
2928              "type": "string",
2929              "description": "Ordering source eg. affiliate, fynd"
2930            },
2931            "journey_type": {
2932              "type": [
2933                "string",
2934                "null"
2935              ],
2936              "description": "Journey type forward or return"
2937            },
2938            "einvoice_info": {
2939              "type": "object",
2940              "description": "Einvoice info if e-invoice is applicable",
2941              "properties": {
2942                "credit_note": {
2943                  "description": "Details of the reverse credit note einvoice",
2944                  "type": "object",
2945                  "properties": {
2946                    "ack_dt": {
2947                      "type": "string",
2948                      "description": "Date and time when the e-invoice acknowledgment was received"
2949                    },
2950                    "ack_no": {
2951                      "type": "string",
2952                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
2953                    },
2954                    "irn": {
2955                      "type": "string",
2956                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
2957                    },
2958                    "signed_invoice": {
2959                      "type": "string",
2960                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
2961                    },
2962                    "signed_qr_code": {
2963                      "x-not-enum": true,
2964                      "type": "string",
2965                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
2966                    },
2967                    "message": {
2968                      "type": "array",
2969                      "description": "Error Message received from JioGSt",
2970                      "items": {
2971                        "type": "object",
2972                        "properties": {
2973                          "ErrorCode": {
2974                            "type": [
2975                              "string",
2976                              "null"
2977                            ]
2978                          },
2979                          "ErrorMessage": {
2980                            "type": [
2981                              "string",
2982                              "null"
2983                            ]
2984                          }
2985                        }
2986                      }
2987                    }
2988                  }
2989                },
2990                "invoice": {
2991                  "description": "Details of the forward invoice einvoice",
2992                  "type": "object",
2993                  "properties": {
2994                    "ack_dt": {
2995                      "type": "string",
2996                      "description": "Date and time when the e-invoice acknowledgment was received"
2997                    },
2998                    "ack_no": {
2999                      "type": "string",
3000                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
3001                    },
3002                    "irn": {
3003                      "type": "string",
3004                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
3005                    },
3006                    "signed_invoice": {
3007                      "type": "string",
3008                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
3009                    },
3010                    "signed_qr_code": {
3011                      "x-not-enum": true,
3012                      "type": "string",
3013                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
3014                    },
3015                    "message": {
3016                      "type": "array",
3017                      "description": "Error Message received from JioGSt",
3018                      "items": {
3019                        "type": "object",
3020                        "properties": {
3021                          "ErrorCode": {
3022                            "type": [
3023                              "string",
3024                              "null"
3025                            ]
3026                          },
3027                          "ErrorMessage": {
3028                            "type": [
3029                              "string",
3030                              "null"
3031                            ]
3032                          }
3033                        }
3034                      }
3035                    }
3036                  }
3037                }
3038              },
3039              "required": []
3040            },
3041            "lock_status": {
3042              "type": "boolean",
3043              "description": "Lock status of the shipment"
3044            },
3045            "original_bag_list": {
3046              "type": "array",
3047              "items": {
3048                "type": "number"
3049              },
3050              "description": "List of Bag ids when the order was created"
3051            },
3052            "shipment_update_time": {
3053              "type": "number",
3054              "description": "Last shipment update time"
3055            },
3056            "previous_shipment_id": {
3057              "type": [
3058                "string",
3059                "null"
3060              ],
3061              "description": "\"ID of the shipment from which current shipment was created,  this is populated whenever the shipment goes into negative state transition\""
3062            },
3063            "fyndstore_emp": {
3064              "type": "object",
3065              "description": "Fynd store employee details",
3066              "properties": {},
3067              "required": []
3068            },
3069            "ordering_store": {
3070              "description": "Store details from which order was placed in case of StoreOS",
3071              "type": "object",
3072              "properties": {
3073                "id": {
3074                  "type": "number",
3075                  "description": "Unique identifier for the store."
3076                },
3077                "code": {
3078                  "type": "string",
3079                  "description": "Alphanumeric code representing the store."
3080                },
3081                "name": {
3082                  "type": "string",
3083                  "description": "Name of the store."
3084                },
3085                "address": {
3086                  "type": "string",
3087                  "description": "Physical address of the store."
3088                },
3089                "state": {
3090                  "type": "string",
3091                  "description": "State where the store is located."
3092                },
3093                "city": {
3094                  "type": "string",
3095                  "description": "City where the store is located."
3096                },
3097                "pincode": {
3098                  "type": "string",
3099                  "description": "Postal code (pincode) of the store's location."
3100                },
3101                "country": {
3102                  "type": "string",
3103                  "description": "Country where the store is situated."
3104                },
3105                "phone": {
3106                  "type": "string",
3107                  "description": "Contact phone number for the store."
3108                },
3109                "fulfillment_channel": {
3110                  "type": "string",
3111                  "description": "Type of fulfillment channel used by the store."
3112                },
3113                "location_type": {
3114                  "type": "string",
3115                  "enum": [
3116                    "high_street",
3117                    "mall",
3118                    "store",
3119                    "warehouse"
3120                  ],
3121                  "description": "Type of location e.g., warehouse, high_street"
3122                },
3123                "company_id": {
3124                  "type": "number",
3125                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
3126                },
3127                "is_active": {
3128                  "type": "boolean",
3129                  "description": "Boolean indicating whether the store is currently active"
3130                },
3131                "tags": {
3132                  "type": "array",
3133                  "items": {
3134                    "type": "string"
3135                  },
3136                  "description": "Array of tags associated with the store"
3137                }
3138              },
3139              "required": []
3140            },
3141            "coupon": {
3142              "type": "object",
3143              "description": "Coupon related details",
3144              "properties": {},
3145              "required": []
3146            },
3147            "cart_info": {
3148              "type": "object",
3149              "description": "Cart related information",
3150              "properties": {
3151                "cart_id": {
3152                  "type": "string",
3153                  "description": "The unique identifier of the cart"
3154                },
3155                "cart_uid": {
3156                  "type": "number",
3157                  "description": "UID associated with the cart"
3158                }
3159              },
3160              "required": [
3161                "cart_id",
3162                "cart_uid"
3163              ]
3164            }
3165          },
3166          "required": [
3167            "status",
3168            "shipment_status",
3169            "application_id",
3170            "shipment_id",
3171            "company_id",
3172            "app_company_id",
3173            "order_id",
3174            "merchant_id",
3175            "user",
3176            "delivery_address",
3177            "billing_address",
3178            "delivery_partner_details",
3179            "bags",
3180            "bag_status_history",
3181            "fulfilling_store",
3182            "prices",
3183            "payments",
3184            "affiliate_details",
3185            "dp_details",
3186            "rto_address",
3187            "weight",
3188            "shipment_gst",
3189            "store_invoice_id",
3190            "credit_note_id",
3191            "order_created",
3192            "payment_methods",
3193            "payment_info",
3194            "order",
3195            "order_source",
3196            "journey_type",
3197            "einvoice_info",
3198            "lock_status",
3199            "original_bag_list",
3200            "shipment_update_time",
3201            "previous_shipment_id",
3202            "fyndstore_emp",
3203            "ordering_store",
3204            "coupon",
3205            "cart_info"
3206          ]
3207        }
3208      },
3209      "required": [
3210        "shipment"
3211      ]
3212    }
3213  }
3214}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "00000000000000003f560c25eb5a6b2d"
5    ],
6    "name": "shipment",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712229384850,
10    "id": "LFdXAVR0SRDTgZ3xOZpv0MSiNFgY7lJlvT2/HehFieI=",
11    "category": "application"
12  },
13  "company_id": 6367,
14  "application_id": "63f893a94adb0bbd79de0344",
15  "contains": [
16    "shipment"
17  ],
18  "payload": {
19    "shipment": {
20      "status": "placed",
21      "shipment_status": {
22        "meta": {
23          "request_meta": {},
24          "estimated_sla_ts": "2024-04-05T00:46:23Z",
25          "estimated_sla_time": "2024-04-05T00:46:23+00:00",
26          "state_manager_used": "entity"
27        },
28        "created_at": "2024-04-04T16:46:25+00:00",
29        "status": "placed",
30        "updated_ts": "2024-04-04T11:16:24Z",
31        "bag_list": [
32          "33938213"
33        ],
34        "shipment_id": "17122293845391234896",
35        "id": 164733749,
36        "created_ts": "2024-04-04T11:16:24Z",
37        "current_shipment_status": "placed",
38        "status_created_at": "2024-04-04T16:46:25+00:00"
39      },
40      "application_id": "63f893a94adb0bbd79de0344",
41      "shipment_id": "17122293845391234896",
42      "company_id": 6367,
43      "app_company_id": 6367,
44      "order_id": "FYMP660E8C0801AD7F2D",
45      "merchant_id": "",
46      "user": {
47        "meta": {
48          "country_phone_code": ""
49        },
50        "email": "test@example.com",
51        "gender": null,
52        "mongo_user_id": null,
53        "last_name": "",
54        "mobile": "1111111111",
55        "user_oid": null,
56        "external_customer_id": null,
57        "first_name": "Test user",
58        "id": 18917956,
59        "country_phone_code": "",
60        "is_anonymous_user": false
61      },
62      "delivery_address": {
63        "area": "",
64        "city": "Jamnagar",
65        "name": "test user ",
66        "email": "test@example.com",
67        "phone": "1111111111",
68        "state": "Gujarat",
69        "address": " test address",
70        "country": "India",
71        "pincode": "361005",
72        "user_id": 18917956,
73        "version": "1.0",
74        "address1": "test address",
75        "address2": "",
76        "landmark": "",
77        "latitude": 0,
78        "area_code": "",
79        "last_name": "",
80        "longitude": 0,
81        "created_at": "2024-04-04T16:46:24+00:00",
82        "first_name": "dummy user",
83        "updated_at": "2024-04-04T16:46:24+00:00",
84        "address_type": "home",
85        "geo_location": {},
86        "area_code_slug": "",
87        "contact_person": "dummy address",
88        "address_category": "",
89        "country_iso_code": "IN",
90        "country_phone_code": null
91      },
92      "billing_address": {
93        "area": "",
94        "city": "Jamnagar",
95        "name": "",
96        "email": "test@example.com",
97        "phone": "1111111111",
98        "state": "Gujarat",
99        "address": "test address",
100        "country": "India",
101        "pincode": "361005",
102        "version": "1.0",
103        "address1": "test address",
104        "address2": "",
105        "landmark": "",
106        "latitude": 0,
107        "area_code": "",
108        "last_name": "",
109        "longitude": 0,
110        "created_at": "2024-04-04 16:46:24",
111        "first_name": "dummy user",
112        "updated_at": "2024-04-04 16:46:24",
113        "address_type": "home",
114        "geo_location": {},
115        "area_code_slug": "",
116        "contact_person": "test user",
117        "display_address": "test address",
118        "address_category": "",
119        "country_iso_code": "IN",
120        "country_phone_code": null
121      },
122      "delivery_partner_details": {
123        "id": null,
124        "name": null,
125        "awb_no": null,
126        "eway_bill_id": null,
127        "track_url": null,
128        "gst_tag": "sgst",
129        "extension_id": null,
130        "scheme_id": null,
131        "courier_partner_slug": null
132      },
133      "bags": [
134        {
135          "financial_breakup": [
136            {
137              "brand_calculated_amount": 130,
138              "discount": 69,
139              "gst_fee": 19.83,
140              "gst_tax_percentage": 18,
141              "gst_tag": "SGST",
142              "hsn_code": "33061020",
143              "identifiers": {
144                "sku_code": "BOTOOTHPASTE_50GM"
145              },
146              "price_marked": 199,
147              "tax_collected_at_source": 0,
148              "tcs_percentage": 0,
149              "total_units": 1,
150              "value_of_good": 110.17,
151              "item_name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",
152              "size": "1"
153            }
154          ],
155          "entity_type": "bag",
156          "item": {
157            "webstore_product_url": null,
158            "last_updated_at": "2024-04-04T16:31:44+00:00",
159            "attributes": {
160              "name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",
161              "gender": [
162                "Unisex"
163              ],
164              "essential": "No",
165              "brand_name": "Generic",
166              "net-quantity": "1 N",
167              "marketer-name": "NATUREOVEDIC CONSUMERS PRIVATE LIMITED",
168              "primary_color": "Black",
169              "marketer-address": "dummy address",
170              "primary_color_hex": "000000",
171              "primary-colour-hex-code": "000000",
172              "media": []
173            },
174            "l2_category": [
175              "Baby Care"
176            ],
177            "name": "Baby Organo Kids Toothpaste Strawberry 50g (0-6 Years)",
178            "l1_category": [
179              "Kids Essentials"
180            ],
181            "gender": null,
182            "l3_category": 1488,
183            "brand_id": 5989,
184            "brand": "Generic",
185            "l3_category_name": "Baby Care Gift Sets",
186            "l2_category_id": 560,
187            "code": "RVWH9ES7KS",
188            "meta": {
189              "tags": [],
190              "departments": [
191                7
192              ]
193            },
194            "slug_key": "baby-organo-kids-toothpaste-strawberry-50g-0-6-years-9917436",
195            "can_cancel": true,
196            "can_return": true,
197            "color": null,
198            "l1_category_id": 554,
199            "id": 9917436,
200            "branch_url": null,
201            "department_id": 7,
202            "size": "1",
203            "image": [
204              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/common/default_item_image.jpg"
205            ]
206          },
207          "brand": {
208            "is_virtual_invoice": false,
209            "credit_note_allowed": false,
210            "brand_name": "Generic",
211            "modified_on": "2023-06-20T19:00:36+00:00",
212            "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/brands/pictures/square-logo/original/AogxD7pYK-Logo.png",
213            "id": 5989,
214            "created_on": "2023-05-24T05:34:01+00:00"
215          },
216          "bag_id": 33938213,
217          "article": {
218            "identifiers": {
219              "sku_code": "BOTOOTHPASTE_50GM"
220            },
221            "esp_modified": "",
222            "size": "1",
223            "code": "",
224            "raw_meta": null,
225            "set": {},
226            "is_set": "",
227            "seller_identifier": "BOTOOTHPASTE_50GM",
228            "return_config": {
229              "time": 1,
230              "unit": "days",
231              "returnable": true
232            },
233            "_id": "659fe876fc7c748f7333b086",
234            "uid": "659fe876fc7c748f7333b086",
235            "child_details": {},
236            "dimensions": {},
237            "weight": {},
238            "currency": {},
239            "expiration_date": null
240          },
241          "current_operational_status": {
242            "delivery_awb_number": null,
243            "bag_id": 33938213,
244            "created_at": "2024-04-04T16:46:25+00:00",
245            "status": "placed",
246            "state_id": 1,
247            "updated_ts": "2024-04-04T11:16:24Z",
248            "delivery_partner_id": null,
249            "shipment_id": "17122293845391234896",
250            "id": 217656545,
251            "state_type": "operational",
252            "updated_at": "2024-04-04T16:46:25+00:00",
253            "created_ts": "2024-04-04T11:16:24Z",
254            "store_id": 22665,
255            "kafka_sync": false,
256            "bag_state_mapper": {
257              "journey_type": "forward",
258              "app_display_name": "Processing",
259              "state_type": "operational",
260              "app_state_name": "processing",
261              "name": "placed",
262              "app_facing": true,
263              "id": 1,
264              "display_name": "Placed",
265              "notify_customer": true,
266              "is_active": true
267            },
268            "reasons": [],
269            "action_user": {}
270          },
271          "affiliate_bag_details": {
272            "affiliate_bag_id": "17122293829511256932J-1",
273            "affiliate_order_id": "17122293670136786A",
274            "affiliate_meta": {
275              "fynd": {
276                "fulfilment_identifier": "pulse",
277                "fulfilment_identifiers_list": [
278                  "pulse"
279                ]
280              },
281              "channel_shipment_id": null,
282              "channel_order_id": null,
283              "due_date": null,
284              "is_priority": false,
285              "box_type": null,
286              "coupon_code": null,
287              "size_level_total_qty": null,
288              "loyalty_discount": 0,
289              "employee_discount": 0
290            },
291            "loyalty_discount": 0,
292            "employee_discount": 0
293          },
294          "payment_methods": {
295            "COD": {
296              "amount": 130
297            }
298          },
299          "quantity": 1,
300          "prices": {
301            "price_effective": 130,
302            "discount": 69,
303            "amount_paid": 130,
304            "coupon_effective_discount": 0,
305            "delivery_charge": 0,
306            "fynd_credits": 0,
307            "cod_charges": 0,
308            "refund_credit": 0,
309            "cashback": 0,
310            "refund_amount": 130,
311            "added_to_fynd_cash": false,
312            "cashback_applied": 0,
313            "gst_tax_percentage": 18,
314            "value_of_good": 110.17,
315            "price_marked": 199,
316            "transfer_price": 0,
317            "brand_calculated_amount": 130,
318            "tax_collected_at_source": 0,
319            "tcs_percentage": 0,
320            "promotion_effective_discount": 0,
321            "gift_price": 0,
322            "coupon_value": 0,
323            "seller_promotion_effective_discount": 0,
324            "fynd_promotion_effective_discount": 0,
325            "amount_paid_roundoff": 130
326          },
327          "order_created": "2024-04-04T16:46:25+00:00",
328          "gst_details": {
329            "gstin_code": "24AAICN1205F1Z0",
330            "gst_tag": "SGST",
331            "hsn_code": "33061020",
332            "value_of_good": 110.17,
333            "gst_tax_percentage": 18,
334            "is_default_hsn_code": false,
335            "brand_calculated_amount": 130,
336            "tax_collected_at_source": 0,
337            "hsn_code_id": "627782f15e4c6fdbc8be30de",
338            "gst_fee": 19.83,
339            "igst_tax_percentage": 0,
340            "sgst_tax_percentage": 9,
341            "cgst_tax_percentage": 9,
342            "igst_gst_fee": "0",
343            "cgst_gst_fee": "9.91",
344            "sgst_gst_fee": "9.91"
345          },
346          "line_number": 1,
347          "applied_promos": [],
348          "meta": {
349            "charges": [
350              {
351                "name": "amount_paid",
352                "type": "amount_paid",
353                "amount": {
354                  "value": 130,
355                  "currency": "INR"
356                }
357              },
358              {
359                "name": "price_effective",
360                "type": "price_effective",
361                "amount": {
362                  "value": 130,
363                  "currency": "INR"
364                }
365              },
366              {
367                "name": "price_marked",
368                "type": "price_marked",
369                "amount": {
370                  "value": 199,
371                  "currency": "INR"
372                }
373              },
374              {
375                "name": "mrp",
376                "type": "mrp",
377                "amount": {
378                  "value": 199,
379                  "currency": "INR"
380                }
381              },
382              {
383                "name": "unit_price",
384                "type": "unit_price",
385                "amount": {
386                  "value": 130,
387                  "currency": "INR"
388                }
389              },
390              {
391                "name": "delivery_charge",
392                "type": "delivery_charge",
393                "amount": {
394                  "value": 0,
395                  "currency": "INR"
396                }
397              },
398              {
399                "name": "discount",
400                "type": "discount",
401                "amount": {
402                  "value": 69,
403                  "currency": "INR"
404                }
405              }
406            ],
407            "group_id": "",
408            "gift_card": {},
409            "docket_number": "171222938453912348961",
410            "partial_can_ret": false,
411            "parent_docket_number": "171222938453912348961",
412            "delivery_charges_hsn_code": "996819",
413            "multi_quantity_bag_enabled": false
414          }
415        }
416      ],
417      "bag_status_history": [
418        {
419          "delivery_awb_number": null,
420          "bag_id": 33938213,
421          "created_at": "2024-04-04T16:46:25+00:00",
422          "status": "pending",
423          "state_id": 89,
424          "updated_ts": "2024-04-04T11:16:24Z",
425          "delivery_partner_id": null,
426          "shipment_id": "17122293845391234896",
427          "id": 217656544,
428          "state_type": "operational",
429          "updated_at": "2024-04-04T16:46:25+00:00",
430          "created_ts": "2024-04-04T11:16:24Z",
431          "store_id": 22665,
432          "kafka_sync": false,
433          "bag_state_mapper": {
434            "journey_type": "forward",
435            "app_display_name": "Pending",
436            "state_type": "operational",
437            "app_state_name": "pending",
438            "name": "pending",
439            "app_facing": true,
440            "id": 89,
441            "display_name": "Pending",
442            "notify_customer": true,
443            "is_active": true
444          },
445          "reasons": [],
446          "action_user": {}
447        },
448        {
449          "delivery_awb_number": null,
450          "bag_id": 33938213,
451          "created_at": "2024-04-04T16:46:25+00:00",
452          "status": "placed",
453          "state_id": 1,
454          "updated_ts": "2024-04-04T11:16:24Z",
455          "delivery_partner_id": null,
456          "shipment_id": "17122293845391234896",
457          "id": 217656545,
458          "state_type": "operational",
459          "updated_at": "2024-04-04T16:46:25+00:00",
460          "created_ts": "2024-04-04T11:16:24Z",
461          "store_id": 22665,
462          "kafka_sync": false,
463          "bag_state_mapper": {
464            "journey_type": "forward",
465            "app_display_name": "Processing",
466            "state_type": "operational",
467            "app_state_name": "processing",
468            "name": "placed",
469            "app_facing": true,
470            "id": 1,
471            "display_name": "Placed",
472            "notify_customer": true,
473            "is_active": true
474          },
475          "reasons": [],
476          "action_user": {}
477        }
478      ],
479      "fulfilling_store": {
480        "id": 22665,
481        "code": "HS-d3483",
482        "name": "Natureovedic Consumers Private Limited",
483        "address": "dummy data",
484        "state": "Gujarat",
485        "city": "Ahmedabad",
486        "pincode": "380015",
487        "country": "India",
488        "phone": "1111111111",
489        "meta": {
490          "timing": [
491            {
492              "weekday": "monday",
493              "opening": {
494                "hour": 11,
495                "minute": 0
496              },
497              "closing": {
498                "hour": 21,
499                "minute": 30
500              },
501              "open": true
502            },
503            {
504              "weekday": "tuesday",
505              "opening": {
506                "hour": 11,
507                "minute": 0
508              },
509              "closing": {
510                "hour": 21,
511                "minute": 30
512              },
513              "open": true
514            },
515            {
516              "weekday": "wednesday",
517              "opening": {
518                "hour": 11,
519                "minute": 0
520              },
521              "closing": {
522                "hour": 21,
523                "minute": 30
524              },
525              "open": true
526            },
527            {
528              "weekday": "thursday",
529              "opening": {
530                "hour": 11,
531                "minute": 0
532              },
533              "closing": {
534                "hour": 21,
535                "minute": 30
536              },
537              "open": true
538            },
539            {
540              "weekday": "friday",
541              "opening": {
542                "hour": 11,
543                "minute": 0
544              },
545              "closing": {
546                "hour": 21,
547                "minute": 30
548              },
549              "open": true
550            },
551            {
552              "weekday": "saturday",
553              "opening": {
554                "hour": 11,
555                "minute": 0
556              },
557              "closing": {
558                "hour": 21,
559                "minute": 30
560              },
561              "open": true
562            },
563            {
564              "weekday": "sunday",
565              "opening": {
566                "hour": 11,
567                "minute": 0
568              },
569              "closing": {
570                "hour": 21,
571                "minute": 30
572              },
573              "open": true
574            }
575          ],
576          "stage": null,
577          "display_name": "Natureovedic Consumers Private Limited",
578          "notification_emails": [
579            "test@example.com"
580          ],
581          "product_return_config": {
582            "on_same_store": true
583          },
584          "gst_credentials": {
585            "e_invoice": {
586              "enabled": false
587            },
588            "e_waybill": {
589              "enabled": false
590            }
591          },
592          "gst_number": "24AAICN1205F1Z0",
593          "additional_contact_details": {
594            "number": [
595              "91 - 8888888888"
596            ]
597          },
598          "documents": {
599            "gst": {
600              "type": "gst",
601              "value": "24AAICN1205F1Z0",
602              "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/6367/stores/all/legal/documents/free/original/gR4EJCW-q-Natureovedic-GST-Gujarat.pdf",
603              "verified": true,
604              "legal_name": "NATUREOVEDIC CONSUMERS PRIVATE LIMITED"
605            }
606          },
607          "auto_invoice": false,
608          "credit_note": false,
609          "ewaybill_portal_details": null
610        },
611        "fulfillment_channel": "pulse",
612        "location_type": "high_street",
613        "company_id": 6367,
614        "is_active": false,
615        "tags": []
616      },
617      "prices": {
618        "amount_paid": 130,
619        "refund_amount": 130,
620        "price_marked": 199,
621        "cod_charges": 0,
622        "discount": 69,
623        "cashback_applied": 0,
624        "delivery_charge": 0,
625        "fynd_credits": 0,
626        "cashback": 0,
627        "price_effective": 130,
628        "refund_credit": 0,
629        "value_of_good": 110.17,
630        "coupon_value": 0,
631        "tax_collected_at_source": 0,
632        "promotion_effective_discount": 0,
633        "fynd_promotion_effective_discount": 0,
634        "seller_promotion_effective_discount": 0,
635        "cn_refund_amount": 0,
636        "gift_price": 0,
637        "amount_paid_roundoff": 130
638      },
639      "payments": {
640        "id": 2,
641        "mode": "COD",
642        "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payment/default_card.png",
643        "display_name": "COD",
644        "display_priority": 1,
645        "source": "Cash on Delivery",
646        "is_active": true
647      },
648      "affiliate_details": {
649        "id": "63f893a94adb0bbd79de0344",
650        "affiliate_bag_id": "17122293829511256932J-1",
651        "affiliate_order_id": "17122293670136786A",
652        "company_affiliate_tag": "JIOMART",
653        "affiliate_id": "63f893a94adb0bbd79de0344",
654        "affiliate_shipment_id": "17122293829511256932J",
655        "shipment_meta": {
656          "sla": null,
657          "weight": 500,
658          "due_date": "2024-04-05T00:46:23.000Z",
659          "external": {},
660          "vertical": "NA",
661          "lock_data": {
662            "mto": false,
663            "locked": false,
664            "lock_message": ""
665          },
666          "bag_weight": {
667            "33938213": 500
668          },
669          "debug_info": {
670            "stormbreaker_uuid": ""
671          },
672          "dp_options": {},
673          "order_type": "HomeDelivery",
674          "dp_sort_key": null,
675          "is_self_ship": false,
676          "delivery_slots": {},
677          "courier_partners": [],
678          "fulfillment_tags": [],
679          "is_international": false,
680          "processing_dates": {
681            "due_date": "2024-04-05T00:46:23.000Z",
682            "dispatch_by_date": "2024-04-05T00:46:23.000Z"
683          },
684          "is_export_shipment": false,
685          "same_store_available": true,
686          "fulfilment_priority_text": null,
687          "auto_trigger_dp_assignment_ACF": true,
688          "eligible_for_split": false
689        },
690        "affiliate_meta": {
691          "fynd": {
692            "fulfilment_identifier": "pulse",
693            "fulfilment_identifiers_list": [
694              "pulse"
695            ]
696          },
697          "channel_shipment_id": null,
698          "channel_order_id": null,
699          "due_date": null,
700          "is_priority": false,
701          "box_type": null,
702          "coupon_code": null,
703          "size_level_total_qty": null,
704          "loyalty_discount": 0,
705          "employee_discount": 0
706        },
707        "affiliate_store_id": "3PPBWQTUJFC03",
708        "pdf_links": {
709          "label_type": "external",
710          "invoice_type": "external"
711        },
712        "config": {
713          "id": "63f893a94adb0bbd79de0344",
714          "meta": [
715            {
716              "name": "shipment_lock_states",
717              "value": [
718                "bag_confirmed",
719                "dp_assigned"
720              ]
721            }
722          ],
723          "name": "JIOMART",
724          "token": null,
725          "dp_assignment": false,
726          "app_company_id": 6367,
727          "article_assignment": {},
728          "force_reassignment": false,
729          "sales_channel_logo": "",
730          "ordering_channel_logo": "",
731          "post_order_reassignment": false
732        }
733      },
734      "article_details": {
735        "status": {
736          "placed": {
737            "659fe876fc7c748f7333b086": {
738              "uid": "659fe876fc7c748f7333b086",
739              "_id": "659fe876fc7c748f7333b086",
740              "is_set": "",
741              "bag_ids": [
742                {
743                  "bag_id": 33938213,
744                  "quantity": 1
745                }
746              ],
747              "quantity": 1,
748              "reasons": {}
749            }
750          }
751        }
752      },
753      "dp_details": {
754        "id": null,
755        "name": null,
756        "awb_no": null,
757        "eway_bill_id": null,
758        "track_url": null,
759        "gst_tag": "sgst",
760        "extension_id": null,
761        "scheme_id": null,
762        "courier_partner_slug": null
763      },
764      "rto_address": {
765        "location_type": "high_street",
766        "name": "Natureovedic Consumers Private Limited",
767        "store_address_json": {
768          "version": "1.0",
769          "contact_person": "test user",
770          "address": "",
771          "address1": "dummy data",
772          "address2": "",
773          "name": "test user",
774          "area": "",
775          "area_code": "",
776          "area_code_slug": "",
777          "landmark": "",
778          "city": "Ahmedabad",
779          "state": "Gujarat",
780          "country": "India",
781          "pincode": "380015",
782          "longitude": 71.5723953,
783          "sector": "",
784          "latitude": 22.6708317,
785          "phone": "1111111111",
786          "email": "test@example.com",
787          "address_type": "store",
788          "address_category": "store",
789          "created_at": "2024-04-04 16:46:24",
790          "updated_at": "2024-04-04 16:46:24",
791          "country_phone_code": null,
792          "country_iso_code": "IN",
793          "country_code": "IN",
794          "display_address": "dummy data"
795        },
796        "id": 22665,
797        "code": "HS-d3483",
798        "company_id": 6367,
799        "address1": "dummy data",
800        "address2": "",
801        "display_address": "dummy data",
802        "city": "Ahmedabad",
803        "state": "Gujarat",
804        "sector": "",
805        "country": "India",
806        "pincode": "380015",
807        "store_email": "test@example.com",
808        "contact_person": "test user",
809        "phone": "1111111111"
810      },
811      "weight": {
812        "value": 500,
813        "unit": "gram"
814      },
815      "shipment_meta": {
816        "sla": null,
817        "weight": 500,
818        "due_date": "2024-04-05T00:46:23.000Z",
819        "external": {},
820        "vertical": "NA",
821        "lock_data": {
822          "mto": false,
823          "locked": false,
824          "lock_message": ""
825        },
826        "bag_weight": {
827          "33938213": 500
828        },
829        "debug_info": {
830          "stormbreaker_uuid": ""
831        },
832        "dp_options": {},
833        "order_type": "HomeDelivery",
834        "dp_sort_key": null,
835        "is_self_ship": false,
836        "delivery_slots": {},
837        "courier_partners": [],
838        "fulfillment_tags": [],
839        "is_international": false,
840        "processing_dates": {
841          "due_date": "2024-04-05T00:46:23.000Z",
842          "dispatch_by_date": "2024-04-05T00:46:23.000Z"
843        },
844        "is_export_shipment": false,
845        "same_store_available": true,
846        "fulfilment_priority_text": null,
847        "auto_trigger_dp_assignment_ACF": true,
848        "eligible_for_split": false
849      },
850      "shipment_gst": {
851        "value_of_good": 110.17,
852        "gst_fee": 19.83,
853        "brand_calculated_amount": 130,
854        "tax_collected_at_source": 0,
855        "gstin_code": "24AAICN1205F1Z0"
856      },
857      "store_invoice_id": null,
858      "credit_note_id": "",
859      "order_created": "2024-04-04T16:46:25+00:00",
860      "payment_methods": {
861        "COD": {
862          "amount": 130,
863          "mode": "COD",
864          "name": "COD",
865          "collect_by": "seller",
866          "refund_by": "seller",
867          "meta": {
868            "payment_id": null
869          }
870        }
871      },
872      "payment_info": [],
873      "order": {
874        "ordering_channel": "MARKETPLACE",
875        "ordering_source": "marketplace",
876        "affiliate_order_date": "2024-04-04T16:46:25+00:00",
877        "affiliate_order_id": "17122293670136786A",
878        "fynd_order_id": "FYMP660E8C0801AD7F2D",
879        "mode_of_payment": "FY_JIOMART",
880        "source": "NA",
881        "total_order_value": 0,
882        "collect_by": "seller",
883        "refund_by": "seller",
884        "order_value": 0,
885        "meta": {
886          "staff": {},
887          "charges": [
888            {
889              "code": "",
890              "name": "COD Charges",
891              "type": "cod_charges",
892              "amount": {
893                "value": 0,
894                "currency": "INR"
895              }
896            },
897            {
898              "code": "",
899              "name": "Delivery Charges",
900              "type": "delivery_charges",
901              "amount": {
902                "value": 0,
903                "currency": "INR"
904              }
905            }
906          ],
907          "currency": {
908            "currency_code": "INR",
909            "currency_name": "Indian Rupee",
910            "currency_symbol": "₹",
911            "currency_sub_unit": "Paisa"
912          },
913          "extra_meta": {},
914          "order_type": "new",
915          "employee_id": "",
916          "company_logo": null,
917          "payment_type": null,
918          "currency_info": {},
919          "mongo_cart_id": 1000000007,
920          "ordering_store": null,
921          "seller_details": {},
922          "conversion_rate": {
923            "base": "INR",
924            "rates": {
925              "INR": {
926                "name": "Indian Rupee",
927                "value": 1,
928                "symbol": "₹",
929                "sub_unit": "Paisa"
930              }
931            },
932            "timestamp": 1712057944.367167
933          },
934          "sales_channel_logo": "",
935          "order_child_entities": [
936            "bag",
937            "shipment"
938          ],
939          "billing_staff_details": {},
940          "ordering_channel_logo": "",
941          "platform_user_details": {},
942          "external_creation_date": "1712249183",
943          "order_tags": []
944        }
945      },
946      "order_source": "NA",
947      "journey_type": "forward",
948      "einvoice_info": {},
949      "lock_status": false,
950      "original_bag_list": [
951        33938213
952      ],
953      "shipment_update_time": 1712229384.71709,
954      "transaction_meta": {},
955      "meta": {
956        "sla": null,
957        "weight": 500,
958        "due_date": "2024-04-05T00:46:23.000Z",
959        "external": {},
960        "vertical": "NA",
961        "lock_data": {
962          "mto": false,
963          "locked": false,
964          "lock_message": ""
965        },
966        "bag_weight": {
967          "33938213": 500
968        },
969        "debug_info": {
970          "stormbreaker_uuid": ""
971        },
972        "dp_options": {},
973        "order_type": "HomeDelivery",
974        "dp_sort_key": null,
975        "is_self_ship": false,
976        "delivery_slots": {},
977        "courier_partners": [],
978        "fulfillment_tags": [],
979        "is_international": false,
980        "processing_dates": {
981          "due_date": "2024-04-05T00:46:23.000Z",
982          "dispatch_by_date": "2024-04-05T00:46:23.000Z"
983        },
984        "is_export_shipment": false,
985        "same_store_available": true,
986        "fulfilment_priority_text": null,
987        "auto_trigger_dp_assignment_ACF": true,
988        "eligible_for_split": false
989      },
990      "previous_shipment_id": null,
991      "fyndstore_emp": {},
992      "ordering_store": {},
993      "coupon": {},
994      "cart_info": {
995        "cart_id": "",
996        "cart_uid": 1000000007
997      }
998    }
999  }
1000}

application/shipment/data_update/v1

this event is triggered when shipment is data_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
shipment
object
Required
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
entity_type
string
Required
Type of entity - bag, shipment
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
The unique identifier associated with the bag
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Shipment weight
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
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      "properties": {
77        "shipment": {
78          "type": "object",
79          "properties": {
80            "status": {
81              "type": "string",
82              "description": "Webhook shipment status, i.e., either create or update"
83            },
84            "shipment_status": {
85              "type": "object",
86              "description": "Status of the shipment indicating its current stage",
87              "properties": {
88                "created_at": {
89                  "type": "string",
90                  "description": "Shipment status created timestamp"
91                },
92                "created_ts": {
93                  "type": "string",
94                  "description": "Shipment status created timestamp"
95                },
96                "id": {
97                  "type": "number",
98                  "description": "Unique identifier associated with the shipment's status object"
99                },
100                "updated_ts": {
101                  "type": "string",
102                  "description": "Shipment status updated timestamp"
103                },
104                "bag_list": {
105                  "type": "array",
106                  "description": "List of Bag ids transitioned in this shipment's status",
107                  "items": {
108                    "type": "string"
109                  }
110                },
111                "shipment_id": {
112                  "type": "string",
113                  "description": "Unique shipment no. that is auto-generated"
114                },
115                "status": {
116                  "type": "string",
117                  "description": "Shipment's operational status"
118                },
119                "current_shipment_status": {
120                  "type": "string",
121                  "description": "Current shipment's status; it can be financial, logistics or operational"
122                },
123                "status_created_at": {
124                  "type": "string"
125                }
126              },
127              "required": [
128                "created_at",
129                "created_ts",
130                "id",
131                "updated_ts",
132                "bag_list",
133                "shipment_id",
134                "status",
135                "current_shipment_status",
136                "status_created_at"
137              ]
138            },
139            "application_id": {
140              "type": "string",
141              "description": "ID of the sales channel to which the shipment belongs"
142            },
143            "shipment_id": {
144              "type": "string",
145              "description": "Unique shipment no. that is auto-generated"
146            },
147            "company_id": {
148              "type": "number",
149              "description": "ID of the company fulfilling the shipment"
150            },
151            "app_company_id": {
152              "type": [
153                "number",
154                "null",
155                "string"
156              ],
157              "description": "ID of the company from which order was placed"
158            },
159            "order_id": {
160              "type": "string",
161              "description": "Unique ID of order in which the shipment is present"
162            },
163            "merchant_id": {
164              "type": "string",
165              "description": "Unique merchant id"
166            },
167            "user": {
168              "type": "object",
169              "description": "Purchaser's details such as name, last name, mobile no. and email",
170              "properties": {
171                "email": {
172                  "type": [
173                    "string",
174                    "null"
175                  ],
176                  "description": "Email address of the purchaser user"
177                },
178                "id": {
179                  "type": [
180                    "number",
181                    "null"
182                  ],
183                  "description": "Unique identifier for the purchaser user within the system"
184                },
185                "gender": {
186                  "type": [
187                    "null",
188                    "string"
189                  ],
190                  "description": "Gender of the purchaser user (e.g., male, female, other)"
191                },
192                "first_name": {
193                  "type": "string",
194                  "description": "First name of the purchaser user"
195                },
196                "external_customer_id": {
197                  "type": [
198                    "string",
199                    "null"
200                  ],
201                  "description": "External identifier associated with the purchaser user in another system"
202                },
203                "mobile": {
204                  "type": [
205                    "string",
206                    "null"
207                  ],
208                  "description": "Mobile phone number of the purchaser user"
209                },
210                "last_name": {
211                  "type": "string",
212                  "description": "Last name of the purchaser user"
213                },
214                "mongo_user_id": {
215                  "type": [
216                    "string",
217                    "null"
218                  ],
219                  "description": "User's object ID in mongodb collection"
220                },
221                "user_oid": {
222                  "type": [
223                    "string",
224                    "null"
225                  ],
226                  "description": "User Object ID assigned within the system"
227                },
228                "country_phone_code": {
229                  "type": [
230                    "string",
231                    "null"
232                  ],
233                  "description": "Country phone code associated with the purchaser user's mobile number"
234                },
235                "is_anonymous_user": {
236                  "type": "boolean",
237                  "description": "Flag indicating whether the user is anonymous"
238                }
239              }
240            },
241            "delivery_address": {
242              "type": "object",
243              "description": "Address where the shipment is to be delivered",
244              "properties": {
245                "area": {
246                  "type": "string",
247                  "description": "A string specifying the locality or area associated with the address"
248                },
249                "city": {
250                  "type": "string",
251                  "description": "A string denoting the city or municipality of the address"
252                },
253                "name": {
254                  "type": "string",
255                  "description": "A string representing the recipient's name or the organization name associated with the address"
256                },
257                "email": {
258                  "type": "string",
259                  "description": "Email of the recipient associated with the delivery address"
260                },
261                "phone": {
262                  "type": "string",
263                  "description": "Mobile phone number of recipient associated with the delivery address"
264                },
265                "state": {
266                  "type": "string",
267                  "description": "A string indicating the state or province of the delivery address"
268                },
269                "address": {
270                  "type": "string",
271                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
272                },
273                "country": {
274                  "type": "string",
275                  "description": "A string indicating the country of the address"
276                },
277                "pincode": {
278                  "type": "string",
279                  "description": "A string indicating the postal code or PIN code of the address area"
280                },
281                "user_id": {
282                  "type": [
283                    "number",
284                    "null"
285                  ],
286                  "description": "Unique identifier for the fulfilling user within the system"
287                },
288                "version": {
289                  "type": "string",
290                  "description": "Address version, to be deprecated"
291                },
292                "address1": {
293                  "type": "string",
294                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
295                },
296                "address2": {
297                  "type": "string",
298                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
299                },
300                "landmark": {
301                  "type": "string",
302                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
303                },
304                "latitude": {
305                  "type": [
306                    "number",
307                    "string"
308                  ],
309                  "description": "The latitude of the address"
310                },
311                "area_code": {
312                  "type": "string",
313                  "x-not-enum": true,
314                  "description": "Area code of the address"
315                },
316                "last_name": {
317                  "type": "string",
318                  "description": "Last name of the recipient associated with the delivery address"
319                },
320                "longitude": {
321                  "type": [
322                    "number",
323                    "string"
324                  ],
325                  "description": "The longitude of the address"
326                },
327                "created_at": {
328                  "type": "string",
329                  "format": "date-time",
330                  "description": "Date and time when the delivery address was created"
331                },
332                "first_name": {
333                  "type": "string",
334                  "description": "First name of the recipient associated with the delivery address"
335                },
336                "updated_at": {
337                  "type": "string",
338                  "format": "date-time",
339                  "description": "Date and time when the delivery address was last updated"
340                },
341                "address_type": {
342                  "type": "string",
343                  "x-not-enum": true,
344                  "description": "Type of address (e.g., home, office, registered)"
345                },
346                "geo_location": {
347                  "required": [],
348                  "description": "Geographic coordinates (latitude and longitude) of the delivery address",
349                  "type": "object",
350                  "properties": {
351                    "latitude": {
352                      "type": [
353                        "number",
354                        "string"
355                      ],
356                      "description": "The latitude of the geolocation"
357                    },
358                    "longitude": {
359                      "type": [
360                        "number",
361                        "string"
362                      ],
363                      "description": "The longitude of the geolocation"
364                    }
365                  }
366                },
367                "area_code_slug": {
368                  "type": "string",
369                  "description": "Unique identifier or slug for the area code associated with the address"
370                },
371                "contact_person": {
372                  "type": "string",
373                  "description": "Name of the contact person associated with the delivery address"
374                },
375                "display_address": {
376                  "type": "string",
377                  "description": "Formatted display version of the delivery address"
378                },
379                "address_category": {
380                  "type": "string",
381                  "x-not-enum": true,
382                  "description": "Category or classification of the delivery address"
383                },
384                "country_iso_code": {
385                  "type": "string",
386                  "x-not-enum": true,
387                  "description": "ISO code representing the country of the delivery address"
388                },
389                "country_phone_code": {
390                  "type": [
391                    "string",
392                    "null"
393                  ],
394                  "x-not-enum": true,
395                  "description": "Phone code for the country of the delivery address"
396                }
397              }
398            },
399            "billing_address": {
400              "type": "object",
401              "description": "Address by which the invoice is created",
402              "properties": {
403                "area": {
404                  "type": "string",
405                  "description": "A string specifying the locality or area associated with the address"
406                },
407                "city": {
408                  "type": "string",
409                  "description": "A string denoting the city or municipality of the address"
410                },
411                "name": {
412                  "type": "string",
413                  "description": "A string representing the billing user's name or the organization name associated with the address"
414                },
415                "email": {
416                  "type": "string",
417                  "description": "Email address associated with the billing address user"
418                },
419                "phone": {
420                  "type": "string",
421                  "description": "Phone number associated with the billing address user"
422                },
423                "state": {
424                  "type": "string",
425                  "description": "A string indicating the state or province of the billing address"
426                },
427                "address": {
428                  "type": "string",
429                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
430                },
431                "country": {
432                  "type": "string",
433                  "description": "A string indicating the country of the address"
434                },
435                "pincode": {
436                  "type": "string",
437                  "description": "A string indicating the postal code or PIN code of the address area"
438                },
439                "version": {
440                  "type": "string",
441                  "description": "Address version, to be deprecated"
442                },
443                "address1": {
444                  "type": "string",
445                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
446                },
447                "address2": {
448                  "type": "string",
449                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
450                },
451                "landmark": {
452                  "type": "string",
453                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
454                },
455                "latitude": {
456                  "type": [
457                    "number",
458                    "string"
459                  ],
460                  "description": "The latitude of the address"
461                },
462                "area_code": {
463                  "type": "string",
464                  "x-not-enum": true,
465                  "description": "Area code of the address"
466                },
467                "last_name": {
468                  "type": "string",
469                  "description": "Last name of the individual associated with the billing address"
470                },
471                "longitude": {
472                  "type": [
473                    "number",
474                    "string"
475                  ],
476                  "description": "The longitude of the address"
477                },
478                "created_at": {
479                  "type": "string",
480                  "format": "date-time",
481                  "description": "Date and time when the billing address was created"
482                },
483                "first_name": {
484                  "type": "string",
485                  "description": "First name of the individual associated with the billing address"
486                },
487                "updated_at": {
488                  "type": "string",
489                  "format": "date-time",
490                  "description": "Date and time when the billing address was last updated"
491                },
492                "address_type": {
493                  "type": "string",
494                  "x-not-enum": true,
495                  "description": "Type of address (e.g., home, office, registered)"
496                },
497                "geo_location": {
498                  "required": [],
499                  "description": "Geographic coordinates (latitude and longitude) of the billing address",
500                  "type": "object",
501                  "properties": {
502                    "latitude": {
503                      "type": [
504                        "number",
505                        "string"
506                      ],
507                      "description": "The latitude of the geolocation"
508                    },
509                    "longitude": {
510                      "type": [
511                        "number",
512                        "string"
513                      ],
514                      "description": "The longitude of the geolocation"
515                    }
516                  }
517                },
518                "area_code_slug": {
519                  "type": "string",
520                  "description": "Unique identifier or slug for the area code associated with the address"
521                },
522                "contact_person": {
523                  "type": "string",
524                  "description": "Name of the contact person associated with the billing address"
525                },
526                "display_address": {
527                  "type": "string",
528                  "description": "Formatted display version of the billing address"
529                },
530                "address_category": {
531                  "type": "string",
532                  "x-not-enum": true,
533                  "description": "Category or classification of the delivery address"
534                },
535                "country_iso_code": {
536                  "type": "string",
537                  "x-not-enum": true,
538                  "description": "ISO code representing the country of the delivery address"
539                },
540                "country_phone_code": {
541                  "type": [
542                    "string",
543                    "null"
544                  ],
545                  "x-not-enum": true,
546                  "description": "Phone code for the country of the delivery address"
547                }
548              }
549            },
550            "delivery_partner_details": {
551              "type": "object",
552              "description": "Delivery Partner details",
553              "properties": {
554                "id": {
555                  "type": [
556                    "string",
557                    "number",
558                    "null"
559                  ],
560                  "description": "Unique identifier for the delivery partner"
561                },
562                "name": {
563                  "type": [
564                    "string",
565                    "null"
566                  ],
567                  "description": "Name of the delivery partner"
568                },
569                "awb_no": {
570                  "type": [
571                    "string",
572                    "null"
573                  ],
574                  "description": "Airway Bill (AWB) number associated with the delivery"
575                },
576                "eway_bill_id": {
577                  "type": [
578                    "string",
579                    "null"
580                  ],
581                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
582                },
583                "track_url": {
584                  "type": [
585                    "string",
586                    "null"
587                  ],
588                  "description": "URL to track the delivery status or shipment details"
589                },
590                "gst_tag": {
591                  "type": [
592                    "string",
593                    "null"
594                  ],
595                  "description": "GST tag of the shipment"
596                },
597                "extension_id": {
598                  "type": [
599                    "string",
600                    "null"
601                  ],
602                  "description": "Unique Identifier of Courier partner Extension"
603                },
604                "scheme_id": {
605                  "type": [
606                    "string",
607                    "null"
608                  ],
609                  "description": "Unique identifier of a Courier partner scheme"
610                },
611                "courier_partner_slug": {
612                  "type": [
613                    "string",
614                    "null"
615                  ],
616                  "description": "Unique identifier containing extension_id and scheme_id"
617                }
618              },
619              "required": [
620                "id",
621                "name",
622                "awb_no",
623                "eway_bill_id",
624                "track_url",
625                "gst_tag",
626                "extension_id",
627                "scheme_id",
628                "courier_partner_slug"
629              ]
630            },
631            "bags": {
632              "type": "array",
633              "description": "Details of all the products/articles in a shipment",
634              "items": {
635                "type": "object",
636                "properties": {
637                  "financial_breakup": {
638                    "type": "array",
639                    "description": "Financial breakup of an item",
640                    "items": {
641                      "type": "object",
642                      "properties": {
643                        "brand_calculated_amount": {
644                          "type": "number",
645                          "description": "Effective selling price  - Brand's additional discounts"
646                        },
647                        "discount": {
648                          "type": "number",
649                          "description": "The total amount discounted from the original MRP/actual price"
650                        },
651                        "gst_fee": {
652                          "type": "number",
653                          "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
654                        },
655                        "gst_tax_percentage": {
656                          "type": "number",
657                          "description": "The percentage rate of GST applied to a product or service"
658                        },
659                        "gst_tag": {
660                          "type": [
661                            "string",
662                            "null"
663                          ],
664                          "description": "Type of GST applied - IGST, CGST, SGST"
665                        },
666                        "hsn_code": {
667                          "type": [
668                            "string",
669                            "null"
670                          ],
671                          "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
672                        },
673                        "identifiers": {
674                          "type": "object",
675                          "description": "Product identifiers",
676                          "properties": {
677                            "sku_code": {
678                              "type": "string",
679                              "description": "SKU code of the product"
680                            }
681                          }
682                        },
683                        "price_marked": {
684                          "type": "number",
685                          "description": "The indicated price or value assigned to an item before any discounts or adjustments"
686                        },
687                        "tax_collected_at_source": {
688                          "type": "number",
689                          "description": "The tax amount collected at the source of income or transaction"
690                        },
691                        "tcs_percentage": {
692                          "type": "number",
693                          "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
694                        },
695                        "total_units": {
696                          "type": "number",
697                          "description": "Total number of units of the item"
698                        },
699                        "value_of_good": {
700                          "type": "number",
701                          "description": "Effective selling price - Product GST Amount"
702                        },
703                        "item_name": {
704                          "type": "string",
705                          "description": "The name of the item being referenced"
706                        },
707                        "size": {
708                          "type": "string",
709                          "description": "The physical dimensions or specifications of the item, indicating its size or measurements"
710                        }
711                      },
712                      "required": [
713                        "brand_calculated_amount",
714                        "discount",
715                        "gst_fee",
716                        "gst_tax_percentage",
717                        "gst_tag",
718                        "hsn_code",
719                        "identifiers",
720                        "price_marked",
721                        "tax_collected_at_source",
722                        "tcs_percentage",
723                        "total_units",
724                        "value_of_good",
725                        "item_name",
726                        "size"
727                      ]
728                    }
729                  },
730                  "entity_type": {
731                    "type": "string",
732                    "description": "Type of entity - bag, shipment"
733                  },
734                  "item": {
735                    "type": "object",
736                    "description": "Item details",
737                    "properties": {
738                      "l3_category_name": {
739                        "type": "string",
740                        "description": "The name of the level 3 category to which the item belongs"
741                      },
742                      "l1_category_id": {
743                        "type": "number",
744                        "description": "ID representing the level 2 category classification of the item"
745                      },
746                      "code": {
747                        "type": "string",
748                        "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"
749                      },
750                      "branch_url": {
751                        "type": [
752                          "null",
753                          "string"
754                        ],
755                        "description": "Branch URL"
756                      },
757                      "l2_category": {
758                        "type": "array",
759                        "items": {
760                          "type": "string",
761                          "x-not-enum": true,
762                          "description": "The name of the level 2 category to which the item belongs"
763                        }
764                      },
765                      "l3_category": {
766                        "type": "number",
767                        "x-not-enum": true,
768                        "description": "ID representing the level 3 category classification of the item"
769                      },
770                      "last_updated_at": {
771                        "type": "string",
772                        "format": "date-time",
773                        "description": "Timestamp when the item was last updated"
774                      },
775                      "id": {
776                        "type": "number",
777                        "description": "ID of the item that is being referred"
778                      },
779                      "name": {
780                        "type": "string",
781                        "description": "The name of the item being referenced"
782                      },
783                      "can_return": {
784                        "type": "boolean",
785                        "description": "Flag indicating if the item is eligible for return"
786                      },
787                      "webstore_product_url": {
788                        "type": [
789                          "null",
790                          "string"
791                        ],
792                        "description": "Product URL"
793                      },
794                      "gender": {
795                        "type": [
796                          "null",
797                          "string"
798                        ],
799                        "description": "Gender associated with an item"
800                      },
801                      "l2_category_id": {
802                        "type": "number",
803                        "description": "ID representing the level 2 category classification of the item"
804                      },
805                      "color": {
806                        "type": [
807                          "null",
808                          "string"
809                        ],
810                        "description": "Color associated with and item"
811                      },
812                      "slug_key": {
813                        "type": "string",
814                        "description": "Automatically generated unique slug of the item"
815                      },
816                      "can_cancel": {
817                        "type": "boolean",
818                        "description": "Flag indicating if the item is eligible for cancellation"
819                      },
820                      "attributes": {
821                        "type": "object",
822                        "description": "An object containing descriptive properties of the item",
823                        "properties": {
824                          "name": {
825                            "type": "string",
826                            "description": "The name or title of the item"
827                          },
828                          "color": {
829                            "type": "string",
830                            "description": "The color description of the item"
831                          },
832                          "essential": {
833                            "type": "string",
834                            "description": "Indicates whether the item is considered essential"
835                          },
836                          "brand_name": {
837                            "type": "string",
838                            "description": "The brand name of the item"
839                          },
840                          "primary_color": {
841                            "type": "string",
842                            "description": "The primary color of the item"
843                          },
844                          "primary_color_hex": {
845                            "type": "string",
846                            "description": "The hexadecimal code representing the primary color"
847                          },
848                          "primary-colour-hex-code": {
849                            "type": "string",
850                            "description": "The hexadecimal code representing the primary color"
851                          },
852                          "media": {
853                            "type": "array",
854                            "description": "An array containing media files associated with the item",
855                            "items": {
856                              "type": "object"
857                            }
858                          }
859                        }
860                      },
861                      "brand_id": {
862                        "type": "number",
863                        "description": "The unique identifier associated with the brand of the item"
864                      },
865                      "brand": {
866                        "type": "string",
867                        "description": "The brand or manufacturer of the item"
868                      },
869                      "l1_category": {
870                        "type": "array",
871                        "items": {
872                          "type": "string",
873                          "x-not-enum": true,
874                          "description": "The name of the level 1 category to which the item belongs"
875                        }
876                      },
877                      "department_id": {
878                        "type": "number",
879                        "description": "The unique identifier representing the department or category to which the item belongs"
880                      },
881                      "size": {
882                        "type": "string",
883                        "description": "The size or dimensions of the item"
884                      },
885                      "image": {
886                        "type": "array",
887                        "items": {
888                          "type": "string",
889                          "description": "Url of the item's image"
890                        }
891                      }
892                    }
893                  },
894                  "brand": {
895                    "type": "object",
896                    "description": "Brand's information",
897                    "properties": {
898                      "credit_note_allowed": {
899                        "type": "boolean",
900                        "description": "If a credit note ID needs to be generated by the system"
901                      },
902                      "created_on": {
903                        "type": "string",
904                        "description": "Date and time when the brand was registered or created"
905                      },
906                      "id": {
907                        "type": "number",
908                        "description": "Unique identifier assigned to the brand for reference and identification"
909                      },
910                      "logo": {
911                        "type": "string",
912                        "description": "Visual representation or emblem associated with the brand"
913                      },
914                      "modified_on": {
915                        "type": "string",
916                        "description": "Date and time of the most recent update or modification to the brand's information"
917                      },
918                      "is_virtual_invoice": {
919                        "type": "boolean",
920                        "description": "If invoice ID needs to be generated by the system"
921                      },
922                      "brand_name": {
923                        "type": "string",
924                        "description": "Name or title of the brand used for identification and representation"
925                      }
926                    },
927                    "required": [
928                      "credit_note_allowed",
929                      "created_on",
930                      "id",
931                      "logo",
932                      "modified_on",
933                      "is_virtual_invoice",
934                      "brand_name"
935                    ]
936                  },
937                  "bag_id": {
938                    "type": "number",
939                    "description": "The unique identifier associated with the bag"
940                  },
941                  "article": {
942                    "type": "object",
943                    "description": "Details of the article",
944                    "properties": {
945                      "identifiers": {
946                        "type": "object",
947                        "description": "Product identifiers",
948                        "properties": {
949                          "sku_code": {
950                            "type": "string"
951                          }
952                        }
953                      },
954                      "esp_modified": {
955                        "type": [
956                          "string",
957                          "boolean"
958                        ],
959                        "description": "Flag representing if effective selling price has been modified"
960                      },
961                      "size": {
962                        "type": "string",
963                        "description": "The physical dimensions or specifications of the article, indicating its size or measurements"
964                      },
965                      "code": {
966                        "type": "string",
967                        "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"
968                      },
969                      "set": {
970                        "description": "Details of the set article containing size distribution",
971                        "type": "object",
972                        "properties": {
973                          "quantity": {
974                            "type": "integer",
975                            "description": "Number of units present"
976                          },
977                          "size_distribution": {
978                            "type": "object",
979                            "description": "Object indicating the distribution of size and quantity of a set article",
980                            "properties": {
981                              "sizes": {
982                                "type": "array",
983                                "description": "Array indicating size wise units present in a set article",
984                                "items": {
985                                  "type": "object",
986                                  "description": "Object indicating the size and quantity distribution of a set article",
987                                  "properties": {
988                                    "pieces": {
989                                      "type": "integer",
990                                      "description": "Number of units of a particular size"
991                                    },
992                                    "size": {
993                                      "type": "string",
994                                      "description": "Size of the article"
995                                    }
996                                  }
997                                }
998                              }
999                            }
1000                          }
1001                        }
1002                      },
1003                      "is_set": {
1004                        "type": [
1005                          "string",
1006                          "boolean"
1007                        ],
1008                        "description": "A boolean indicating whether the article is a set"
1009                      },
1010                      "seller_identifier": {
1011                        "type": "string",
1012                        "description": "Seller's identifier of the article"
1013                      },
1014                      "return_config": {
1015                        "type": "object",
1016                        "description": "Return configuration details of the article",
1017                        "properties": {
1018                          "time": {
1019                            "type": "number",
1020                            "description": "Number indicating number of hours or days"
1021                          },
1022                          "unit": {
1023                            "type": "string",
1024                            "description": "String indicating the unit of the time, eg. days, hours"
1025                          },
1026                          "returnable": {
1027                            "type": "boolean",
1028                            "description": "Flag indicating whether product is returnable or not"
1029                          }
1030                        },
1031                        "required": [
1032                          "time",
1033                          "unit",
1034                          "returnable"
1035                        ]
1036                      },
1037                      "_id": {
1038                        "type": "string",
1039                        "description": "DB generated ID of the article"
1040                      },
1041                      "uid": {
1042                        "type": "string",
1043                        "description": "UID of the article"
1044                      },
1045                      "child_details": {
1046                        "type": [
1047                          "object",
1048                          "array"
1049                        ],
1050                        "description": "Child article details if any",
1051                        "properties": {},
1052                        "required": []
1053                      },
1054                      "dimensions": {
1055                        "description": "The dimension object of the article/item",
1056                        "required": [],
1057                        "type": "object",
1058                        "properties": {
1059                          "height": {
1060                            "type": [
1061                              "number",
1062                              "null"
1063                            ],
1064                            "description": "The height of the product"
1065                          },
1066                          "width": {
1067                            "type": [
1068                              "number",
1069                              "null"
1070                            ],
1071                            "description": "The width of the product"
1072                          },
1073                          "is_default": {
1074                            "type": [
1075                              "boolean",
1076                              "null"
1077                            ],
1078                            "description": "Whether the dimension is the default one or not"
1079                          },
1080                          "unit": {
1081                            "type": [
1082                              "string",
1083                              "null"
1084                            ],
1085                            "description": "The unit of dimension"
1086                          },
1087                          "length": {
1088                            "type": [
1089                              "number",
1090                              "null"
1091                            ],
1092                            "description": "The length of the product"
1093                          }
1094                        }
1095                      },
1096                      "weight": {
1097                        "required": [],
1098                        "type": "object",
1099                        "description": "Object containing weight details of item/article",
1100                        "properties": {
1101                          "unit": {
1102                            "type": "string",
1103                            "description": "The unit of weight",
1104                            "example": "kg"
1105                          },
1106                          "shipping": {
1107                            "type": "number",
1108                            "description": "The shipping weight of the product",
1109                            "example": 1.5
1110                          },
1111                          "is_default": {
1112                            "type": "boolean",
1113                            "description": "Whether the weight is the default one or not",
1114                            "example": true
1115                          }
1116                        }
1117                      },
1118                      "currency": {
1119                        "type": "object",
1120                        "description": "Order currency details",
1121                        "properties": {
1122                          "code": {
1123                            "type": "string",
1124                            "description": "Currency code"
1125                          },
1126                          "rate": {
1127                            "type": "number",
1128                            "description": "The conversion rate value"
1129                          }
1130                        },
1131                        "required": []
1132                      },
1133                      "expiration_date": {}
1134                    },
1135                    "required": [
1136                      "identifiers",
1137                      "esp_modified",
1138                      "size",
1139                      "code",
1140                      "set",
1141                      "is_set",
1142                      "seller_identifier",
1143                      "return_config",
1144                      "_id",
1145                      "uid",
1146                      "child_details",
1147                      "dimensions",
1148                      "weight",
1149                      "currency",
1150                      "expiration_date"
1151                    ]
1152                  },
1153                  "current_operational_status": {
1154                    "type": "object",
1155                    "properties": {
1156                      "created_at": {
1157                        "type": "string",
1158                        "format": "date-time",
1159                        "description": "Date and time when the shipment status record was created"
1160                      },
1161                      "created_ts": {
1162                        "type": "string",
1163                        "description": "Timestamp indicating the exact time when the shipment status record was created"
1164                      },
1165                      "id": {
1166                        "type": "number",
1167                        "description": "Unique identifier for the shipment status record"
1168                      },
1169                      "kafka_sync": {
1170                        "type": "boolean",
1171                        "description": "Flag indicating whether the shipment status update has been sync with Kafka"
1172                      },
1173                      "updated_ts": {
1174                        "type": "string",
1175                        "description": "Timestamp indicating the last time the shipment status record was updated"
1176                      },
1177                      "updated_at": {
1178                        "type": "string",
1179                        "format": "date-time",
1180                        "description": "Date and time of the most recent update to the shipment status record"
1181                      },
1182                      "delivery_partner_id": {
1183                        "type": [
1184                          "integer",
1185                          "null"
1186                        ],
1187                        "description": "Unique identifier of delivery partner"
1188                      },
1189                      "shipment_id": {
1190                        "type": "string",
1191                        "description": "Unique shipment no. that is auto-generated"
1192                      },
1193                      "store_id": {
1194                        "type": "number",
1195                        "description": "ID of the fulfilling store of the shipment"
1196                      },
1197                      "status": {
1198                        "type": "string",
1199                        "description": "Current operational status of the shipment"
1200                      },
1201                      "bag_id": {
1202                        "type": "number",
1203                        "description": "The unique identifier associated with the bag"
1204                      },
1205                      "state_id": {
1206                        "type": "number",
1207                        "description": "The unique identifier associated with the state"
1208                      },
1209                      "state_type": {
1210                        "type": "string",
1211                        "enum": [
1212                          "operational",
1213                          "logistics",
1214                          "financial"
1215                        ],
1216                        "description": "Type of the state - operational, logistics, financial"
1217                      },
1218                      "delivery_awb_number": {
1219                        "type": [
1220                          "string",
1221                          "null"
1222                        ],
1223                        "description": "Airway Bill (AWB) number associated with the delivery"
1224                      },
1225                      "bag_state_mapper": {
1226                        "type": "object",
1227                        "description": "Object representing properties of the state",
1228                        "properties": {
1229                          "journey_type": {
1230                            "type": [
1231                              "string",
1232                              "null"
1233                            ],
1234                            "enum": [
1235                              "forward",
1236                              "return"
1237                            ],
1238                            "description": "Journey type can be forward or return"
1239                          },
1240                          "app_display_name": {
1241                            "type": "string",
1242                            "description": "The display name of a shipment status as it appears on the sale channel's website"
1243                          },
1244                          "state_type": {
1245                            "type": "string",
1246                            "enum": [
1247                              "operational",
1248                              "logistics",
1249                              "financial"
1250                            ],
1251                            "description": "Type of the state - operational, logistics, financial"
1252                          },
1253                          "app_state_name": {
1254                            "type": "string",
1255                            "description": "The slug of a shipment status from the sale channel's front"
1256                          },
1257                          "name": {
1258                            "type": "string",
1259                            "description": "The slug of a shipment status from the platform's front"
1260                          },
1261                          "app_facing": {
1262                            "type": "boolean",
1263                            "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1264                          },
1265                          "id": {
1266                            "type": "number",
1267                            "description": "The unique identifier associated with the state"
1268                          },
1269                          "display_name": {
1270                            "type": "string",
1271                            "description": "The display name of a shipment status as it appears on the platform"
1272                          },
1273                          "is_active": {
1274                            "type": "boolean",
1275                            "description": "A boolean flag indicating whether a state is active or not"
1276                          }
1277                        },
1278                        "required": [
1279                          "journey_type",
1280                          "app_display_name",
1281                          "state_type",
1282                          "app_state_name",
1283                          "name",
1284                          "app_facing",
1285                          "id",
1286                          "display_name",
1287                          "is_active"
1288                        ]
1289                      },
1290                      "reasons": {
1291                        "type": "array",
1292                        "items": {
1293                          "type": "object",
1294                          "properties": {
1295                            "slug": {
1296                              "type": "string",
1297                              "description": "System generated slug"
1298                            },
1299                            "display_name": {
1300                              "type": "string",
1301                              "description": "Text that is displayed on the application front"
1302                            },
1303                            "id": {
1304                              "type": "integer",
1305                              "description": "System generated ID of the reason object"
1306                            },
1307                            "state": {
1308                              "type": [
1309                                "integer",
1310                                "string"
1311                              ],
1312                              "description": "State associated with the reason"
1313                            },
1314                            "text": {
1315                              "type": "string",
1316                              "description": "Reason text"
1317                            },
1318                            "quantity": {
1319                              "type": "integer",
1320                              "description": "No of quantity that is being cancelled"
1321                            },
1322                            "inventory_flag": {
1323                              "type": "boolean",
1324                              "description": "Inventory depletion action to be taken or not"
1325                            }
1326                          }
1327                        },
1328                        "description": "Reasons associated with the current shipment's status"
1329                      },
1330                      "action_user": {
1331                        "description": "Details of the user who initiated the change in the shipment's status",
1332                        "required": [],
1333                        "type": "object",
1334                        "properties": {
1335                          "title": {
1336                            "type": "string",
1337                            "description": "The title of the user eg. Staff, Admin",
1338                            "example": "Staff"
1339                          },
1340                          "user_id": {
1341                            "type": "string",
1342                            "description": "System generated ID associated with the user",
1343                            "example": "23546659"
1344                          },
1345                          "user_name": {
1346                            "type": "string",
1347                            "description": "System generated username associated with the user",
1348                            "example": "65967faf620ff7c9db513d9c"
1349                          },
1350                          "order_role": {
1351                            "type": "string",
1352                            "description": "Order role associated with the user eg. company_operation, store_manager",
1353                            "example": "full_access"
1354                          },
1355                          "employee_code": {
1356                            "type": "string",
1357                            "x-not-enum": true,
1358                            "description": "Employee code associated with the user",
1359                            "example": "EM-102"
1360                          }
1361                        }
1362                      }
1363                    },
1364                    "required": [
1365                      "created_at",
1366                      "created_ts",
1367                      "id",
1368                      "kafka_sync",
1369                      "updated_ts",
1370                      "updated_at",
1371                      "delivery_partner_id",
1372                      "shipment_id",
1373                      "store_id",
1374                      "status",
1375                      "bag_id",
1376                      "state_id",
1377                      "state_type",
1378                      "delivery_awb_number",
1379                      "bag_state_mapper",
1380                      "reasons",
1381                      "action_user"
1382                    ]
1383                  },
1384                  "affiliate_bag_details": {
1385                    "type": "object",
1386                    "description": "Object containing external bag details like external order id, external bag id",
1387                    "properties": {
1388                      "affiliate_bag_id": {
1389                        "type": "string",
1390                        "description": "External bag id"
1391                      },
1392                      "affiliate_order_id": {
1393                        "type": "string",
1394                        "description": "External order id"
1395                      }
1396                    },
1397                    "required": [
1398                      "affiliate_bag_id",
1399                      "affiliate_order_id"
1400                    ]
1401                  },
1402                  "payment_methods": {
1403                    "type": "object",
1404                    "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
1405                  },
1406                  "quantity": {
1407                    "type": "number",
1408                    "description": "Total quantity of the article present in the bag."
1409                  },
1410                  "prices": {
1411                    "type": "object",
1412                    "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
1413                    "properties": {
1414                      "price_effective": {
1415                        "type": "number",
1416                        "description": "MRP - Initial Seller provided discount"
1417                      },
1418                      "discount": {
1419                        "type": "number",
1420                        "description": "The total amount discounted from the original MRP/actual price"
1421                      },
1422                      "amount_paid": {
1423                        "type": "number",
1424                        "description": "Amount paid by the customer"
1425                      },
1426                      "coupon_effective_discount": {
1427                        "type": "number",
1428                        "description": "Coupon provided by brand or seller"
1429                      },
1430                      "delivery_charge": {
1431                        "type": "number",
1432                        "description": "The fee associated with the delivery service for transporting the item to its destination"
1433                      },
1434                      "fynd_credits": {
1435                        "type": "number",
1436                        "description": "Credits provided by Fynd"
1437                      },
1438                      "cod_charges": {
1439                        "type": "number",
1440                        "description": "The fee associated with the COD order"
1441                      },
1442                      "refund_credit": {
1443                        "type": "number",
1444                        "description": "Refund credits provided to the customer"
1445                      },
1446                      "cashback": {
1447                        "type": "number",
1448                        "description": "Cashback points"
1449                      },
1450                      "refund_amount": {
1451                        "type": "number",
1452                        "description": "Amount to be refunded on cancellation and return"
1453                      },
1454                      "added_to_fynd_cash": {
1455                        "type": "boolean",
1456                        "description": "Flag indicating whether fynd cash has been used"
1457                      },
1458                      "cashback_applied": {
1459                        "type": "number",
1460                        "description": "Cashback applied on the order"
1461                      },
1462                      "gst_tax_percentage": {
1463                        "type": "number",
1464                        "description": "The percentage rate of GST applied to a product or service"
1465                      },
1466                      "value_of_good": {
1467                        "type": "number",
1468                        "description": "Effective selling price - Product GST Amount"
1469                      },
1470                      "price_marked": {
1471                        "type": "number",
1472                        "description": "The indicated price or value assigned to an item before any discounts or adjustments"
1473                      },
1474                      "transfer_price": {
1475                        "type": "number",
1476                        "description": "article"
1477                      },
1478                      "brand_calculated_amount": {
1479                        "type": "number",
1480                        "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"
1481                      },
1482                      "tax_collected_at_source": {
1483                        "type": "number",
1484                        "description": "The tax amount collected at the source of income or transaction"
1485                      },
1486                      "tcs_percentage": {
1487                        "type": "number",
1488                        "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
1489                      },
1490                      "promotion_effective_discount": {
1491                        "type": "number",
1492                        "description": "Effective promotion discount including promotions given by seller and Platform"
1493                      },
1494                      "gift_price": {
1495                        "type": "number",
1496                        "description": "Gift card amount used"
1497                      },
1498                      "coupon_value": {
1499                        "type": "number",
1500                        "description": "Stores the coupon value as shown in the cart"
1501                      },
1502                      "seller_promotion_effective_discount": {
1503                        "type": "number",
1504                        "description": "Promotion discount given by the seller"
1505                      },
1506                      "fynd_promotion_effective_discount": {
1507                        "type": "number",
1508                        "description": "Promotion discount given by Platform/fynd"
1509                      },
1510                      "amount_paid_roundoff": {
1511                        "type": "number",
1512                        "description": "Amount paid rounded off"
1513                      }
1514                    },
1515                    "required": [
1516                      "price_effective",
1517                      "discount",
1518                      "amount_paid",
1519                      "coupon_effective_discount",
1520                      "delivery_charge",
1521                      "fynd_credits",
1522                      "cod_charges",
1523                      "refund_credit",
1524                      "cashback",
1525                      "refund_amount",
1526                      "added_to_fynd_cash",
1527                      "cashback_applied",
1528                      "gst_tax_percentage",
1529                      "value_of_good",
1530                      "price_marked",
1531                      "transfer_price",
1532                      "brand_calculated_amount",
1533                      "tax_collected_at_source",
1534                      "tcs_percentage",
1535                      "promotion_effective_discount",
1536                      "gift_price",
1537                      "coupon_value",
1538                      "seller_promotion_effective_discount",
1539                      "fynd_promotion_effective_discount",
1540                      "amount_paid_roundoff"
1541                    ]
1542                  },
1543                  "order_created": {
1544                    "type": "string",
1545                    "description": "Order creation timestamp"
1546                  },
1547                  "gst_details": {
1548                    "type": "object",
1549                    "description": "GST details associated with the bag",
1550                    "properties": {
1551                      "gstin_code": {
1552                        "type": [
1553                          "string",
1554                          "null"
1555                        ],
1556                        "x-not-enum": true,
1557                        "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
1558                      },
1559                      "gst_tag": {
1560                        "type": [
1561                          "string",
1562                          "null"
1563                        ],
1564                        "description": "Type of GST applied - IGST, CGST, SGST"
1565                      },
1566                      "hsn_code": {
1567                        "type": [
1568                          "string",
1569                          "null"
1570                        ],
1571                        "x-not-enum": true,
1572                        "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
1573                      },
1574                      "value_of_good": {
1575                        "type": "number",
1576                        "description": "Effective selling price - Product GST Amount"
1577                      },
1578                      "gst_tax_percentage": {
1579                        "type": "number",
1580                        "description": "The percentage rate of GST applied to a product or service"
1581                      },
1582                      "is_default_hsn_code": {
1583                        "type": "boolean"
1584                      },
1585                      "brand_calculated_amount": {
1586                        "type": "number",
1587                        "description": "Effective selling price  - Brand's additional discounts"
1588                      },
1589                      "tax_collected_at_source": {
1590                        "type": "number",
1591                        "description": "The tax amount collected at the source of income or transaction"
1592                      },
1593                      "hsn_code_id": {
1594                        "type": [
1595                          "string",
1596                          "null"
1597                        ],
1598                        "description": "The unique identifier associated with HSN code"
1599                      },
1600                      "gst_fee": {
1601                        "type": "number",
1602                        "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
1603                      },
1604                      "igst_tax_percentage": {
1605                        "type": "number",
1606                        "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"
1607                      },
1608                      "sgst_tax_percentage": {
1609                        "type": "number",
1610                        "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"
1611                      },
1612                      "cgst_tax_percentage": {
1613                        "type": "number",
1614                        "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"
1615                      },
1616                      "igst_gst_fee": {
1617                        "type": [
1618                          "string",
1619                          "number"
1620                        ],
1621                        "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"
1622                      },
1623                      "cgst_gst_fee": {
1624                        "type": "string",
1625                        "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"
1626                      },
1627                      "sgst_gst_fee": {
1628                        "type": "string",
1629                        "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"
1630                      }
1631                    },
1632                    "required": [
1633                      "gstin_code",
1634                      "gst_tag",
1635                      "hsn_code",
1636                      "value_of_good",
1637                      "gst_tax_percentage",
1638                      "is_default_hsn_code",
1639                      "brand_calculated_amount",
1640                      "tax_collected_at_source",
1641                      "hsn_code_id",
1642                      "gst_fee",
1643                      "igst_tax_percentage",
1644                      "sgst_tax_percentage",
1645                      "cgst_tax_percentage",
1646                      "igst_gst_fee",
1647                      "cgst_gst_fee",
1648                      "sgst_gst_fee"
1649                    ]
1650                  },
1651                  "line_number": {
1652                    "type": "number",
1653                    "description": "Unique identifier associated with each bag in a shipment"
1654                  },
1655                  "applied_promos": {
1656                    "type": "array",
1657                    "items": {
1658                      "type": "object",
1659                      "properties": {
1660                        "promo_id": {
1661                          "type": "string",
1662                          "description": "Promotion id"
1663                        },
1664                        "buy_rules": {
1665                          "description": "Buy rules for promotions",
1666                          "type": "array",
1667                          "items": {
1668                            "type": "object",
1669                            "properties": {
1670                              "item_criteria": {
1671                                "type": "object",
1672                                "description": "Item criteria of promotion"
1673                              },
1674                              "cart_conditions": {
1675                                "type": "object",
1676                                "description": "Cart conditions details for promotion"
1677                              }
1678                            }
1679                          }
1680                        },
1681                        "offer_text": {
1682                          "type": "string",
1683                          "description": "Offer text of current promotion"
1684                        },
1685                        "promotion_group": {
1686                          "type": "string",
1687                          "description": "Promotion group for the promotion"
1688                        },
1689                        "mrp_promotion": {
1690                          "type": "boolean",
1691                          "description": "If applied promotion is applied on product MRP or ESP"
1692                        },
1693                        "promotion_name": {
1694                          "type": "string",
1695                          "description": "Promotion name of current promotion"
1696                        },
1697                        "amount": {
1698                          "type": "number",
1699                          "description": "Per unit discount amount applied with current promotion"
1700                        },
1701                        "discount_rules": {
1702                          "description": "Discount rules for promotions",
1703                          "type": "array",
1704                          "items": {
1705                            "type": "object",
1706                            "properties": {
1707                              "matched_buy_rules": {
1708                                "type": "array",
1709                                "description": "Matched buy rules for promotion",
1710                                "items": {
1711                                  "type": "string"
1712                                }
1713                              },
1714                              "raw_offer": {
1715                                "type": "object",
1716                                "description": "raw offer details for promotion"
1717                              },
1718                              "offer": {
1719                                "type": "object",
1720                                "description": "offer for promotion"
1721                              },
1722                              "item_criteria": {
1723                                "type": "object",
1724                                "description": "Item criteria of promotion"
1725                              }
1726                            }
1727                          }
1728                        },
1729                        "ownership": {
1730                          "type": "object",
1731                          "description": "Ownership of promotion",
1732                          "properties": {
1733                            "payable_category": {
1734                              "type": "string",
1735                              "x-not-enum": true,
1736                              "description": "promo amount payable category"
1737                            },
1738                            "payable_by": {
1739                              "type": "string",
1740                              "description": "promo amount bearable party"
1741                            }
1742                          }
1743                        },
1744                        "article_quantity": {
1745                          "type": "integer",
1746                          "description": "Quantity of article on which promotion is applicable"
1747                        },
1748                        "applied_free_articles": {
1749                          "description": "Applied free article for free gift item promotions",
1750                          "type": "array",
1751                          "items": {
1752                            "type": "object",
1753                            "properties": {
1754                              "free_gift_item_details": {
1755                                "description": "Free gift items details",
1756                                "type": "object",
1757                                "properties": {
1758                                  "item_slug": {
1759                                    "type": "string",
1760                                    "description": "item slug"
1761                                  },
1762                                  "item_name": {
1763                                    "type": "string",
1764                                    "description": "Item name"
1765                                  },
1766                                  "item_price_details": {
1767                                    "type": "object",
1768                                    "description": "item price details"
1769                                  },
1770                                  "item_brand_name": {
1771                                    "type": "string",
1772                                    "description": "item brand name"
1773                                  },
1774                                  "item_id": {
1775                                    "type": "integer",
1776                                    "description": "Item id"
1777                                  },
1778                                  "item_images_url": {
1779                                    "type": "array",
1780                                    "description": "item images URL",
1781                                    "items": {
1782                                      "type": "string"
1783                                    }
1784                                  }
1785                                }
1786                              },
1787                              "parent_item_identifier": {
1788                                "type": "string",
1789                                "description": "Parent item identifier for free article"
1790                              },
1791                              "quantity": {
1792                                "type": "integer",
1793                                "description": "Free article quantity"
1794                              },
1795                              "article_id": {
1796                                "type": "string",
1797                                "description": "free article id"
1798                              }
1799                            }
1800                          }
1801                        },
1802                        "promotion_type": {
1803                          "type": "string",
1804                          "x-not-enum": true,
1805                          "description": "Promotion type of current promotion"
1806                        },
1807                        "meta": {
1808                          "type": "object",
1809                          "additionalProperties": true,
1810                          "description": "Meta object for extra data"
1811                        },
1812                        "code": {
1813                          "type": [
1814                            "string",
1815                            "null"
1816                          ],
1817                          "description": "Promotion code"
1818                        }
1819                      }
1820                    }
1821                  }
1822                },
1823                "required": [
1824                  "financial_breakup",
1825                  "entity_type",
1826                  "item",
1827                  "brand",
1828                  "bag_id",
1829                  "article",
1830                  "current_operational_status",
1831                  "affiliate_bag_details",
1832                  "payment_methods",
1833                  "quantity",
1834                  "prices",
1835                  "order_created",
1836                  "gst_details",
1837                  "line_number",
1838                  "applied_promos"
1839                ]
1840              }
1841            },
1842            "bag_status_history": {
1843              "type": "array",
1844              "description": "Records the changes in status for a bag, providing a timeline of events and transitions",
1845              "items": {
1846                "type": "object",
1847                "properties": {
1848                  "created_at": {
1849                    "type": "string",
1850                    "format": "date-time",
1851                    "description": "Date and time when the bag status history record was created."
1852                  },
1853                  "created_ts": {
1854                    "type": "string",
1855                    "description": "Timestamp indicating the exact time when the bag status history record was created"
1856                  },
1857                  "id": {
1858                    "type": "number",
1859                    "description": "Unique identifier for the bag status history record"
1860                  },
1861                  "kafka_sync": {
1862                    "type": "boolean",
1863                    "description": "Flag indicating whether the bag status history update has been sync with Kafka"
1864                  },
1865                  "updated_ts": {
1866                    "type": "string",
1867                    "description": "Timestamp indicating the last time the bag status history record was updated"
1868                  },
1869                  "updated_at": {
1870                    "format": "date-time",
1871                    "type": "string",
1872                    "description": "Date and time of the most recent update to the bag status history record"
1873                  },
1874                  "delivery_partner_id": {
1875                    "type": [
1876                      "integer",
1877                      "null"
1878                    ],
1879                    "description": "Unique identifier of delivery partner"
1880                  },
1881                  "shipment_id": {
1882                    "type": "string",
1883                    "description": "Unique shipment no. that is auto-generated"
1884                  },
1885                  "store_id": {
1886                    "type": "number",
1887                    "description": "Store id associated with the bag"
1888                  },
1889                  "status": {
1890                    "type": "string",
1891                    "description": "Webhook shipment status, i.e., either create or update"
1892                  },
1893                  "bag_id": {
1894                    "type": "number",
1895                    "description": "The unique identifier associated with the bag"
1896                  },
1897                  "state_id": {
1898                    "type": "number",
1899                    "description": "The unique identifier associated with the state"
1900                  },
1901                  "state_type": {
1902                    "type": "string",
1903                    "enum": [
1904                      "operational",
1905                      "logistics",
1906                      "financial"
1907                    ],
1908                    "description": "Type of the state - operational, logistics, financial"
1909                  },
1910                  "delivery_awb_number": {
1911                    "type": [
1912                      "string",
1913                      "null"
1914                    ],
1915                    "description": "Airway Bill (AWB) number associated with the delivery"
1916                  },
1917                  "bag_state_mapper": {
1918                    "type": "object",
1919                    "description": "Object representing properties of the state",
1920                    "properties": {
1921                      "journey_type": {
1922                        "type": [
1923                          "string",
1924                          "null"
1925                        ],
1926                        "enum": [
1927                          "forward",
1928                          "return"
1929                        ],
1930                        "description": "Journey type can be forward or return"
1931                      },
1932                      "app_display_name": {
1933                        "type": "string",
1934                        "description": "The display name of a shipment status as it appears on the sale channel's website"
1935                      },
1936                      "state_type": {
1937                        "type": "string",
1938                        "enum": [
1939                          "operational",
1940                          "logistics",
1941                          "financial"
1942                        ],
1943                        "description": "Type of the state - operational, logistics, financial"
1944                      },
1945                      "app_state_name": {
1946                        "type": "string",
1947                        "description": "The slug of a shipment status from the sale channel's front"
1948                      },
1949                      "name": {
1950                        "type": "string",
1951                        "description": "The slug of a shipment status from the platform's front"
1952                      },
1953                      "app_facing": {
1954                        "type": "boolean",
1955                        "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1956                      },
1957                      "id": {
1958                        "type": "number",
1959                        "description": "The unique identifier associated with the state"
1960                      },
1961                      "display_name": {
1962                        "type": "string",
1963                        "description": "The display name of a shipment status as it appears on the platform"
1964                      },
1965                      "is_active": {
1966                        "type": "boolean",
1967                        "description": "A boolean flag indicating whether a state is active or not"
1968                      }
1969                    },
1970                    "required": [
1971                      "journey_type",
1972                      "app_display_name",
1973                      "state_type",
1974                      "app_state_name",
1975                      "name",
1976                      "app_facing",
1977                      "id",
1978                      "display_name",
1979                      "is_active"
1980                    ]
1981                  },
1982                  "reasons": {
1983                    "type": "array",
1984                    "items": {
1985                      "type": "object",
1986                      "properties": {
1987                        "slug": {
1988                          "type": "string",
1989                          "description": "System generated slug"
1990                        },
1991                        "display_name": {
1992                          "type": "string",
1993                          "description": "Text that is displayed on the application front"
1994                        },
1995                        "id": {
1996                          "type": "integer",
1997                          "description": "System generated ID of the reason object"
1998                        },
1999                        "state": {
2000                          "type": [
2001                            "integer",
2002                            "string"
2003                          ],
2004                          "description": "State associated with the reason"
2005                        },
2006                        "text": {
2007                          "type": "string",
2008                          "description": "Reason text"
2009                        },
2010                        "quantity": {
2011                          "type": "integer",
2012                          "description": "No of quantity that is being cancelled"
2013                        },
2014                        "inventory_flag": {
2015                          "type": "boolean",
2016                          "description": "Inventory depletion action to be taken or not"
2017                        }
2018                      }
2019                    },
2020                    "description": "Reasons associated with the current shipment's status"
2021                  },
2022                  "action_user": {
2023                    "type": "object",
2024                    "properties": {
2025                      "title": {
2026                        "type": "string",
2027                        "description": "The title of the user eg. Staff, Admin",
2028                        "example": "Staff"
2029                      },
2030                      "user_id": {
2031                        "type": "string",
2032                        "description": "System generated ID associated with the user",
2033                        "example": "23546659"
2034                      },
2035                      "user_name": {
2036                        "type": "string",
2037                        "description": "System generated username associated with the user",
2038                        "example": "65967faf620ff7c9db513d9c"
2039                      },
2040                      "order_role": {
2041                        "type": "string",
2042                        "description": "Order role associated with the user eg. company_operation, store_manager",
2043                        "example": "full_access"
2044                      },
2045                      "employee_code": {
2046                        "type": "string",
2047                        "x-not-enum": true,
2048                        "description": "Employee code associated with the user",
2049                        "example": "EM-102"
2050                      }
2051                    },
2052                    "required": []
2053                  }
2054                },
2055                "required": [
2056                  "created_at",
2057                  "created_ts",
2058                  "id",
2059                  "kafka_sync",
2060                  "updated_ts",
2061                  "updated_at",
2062                  "delivery_partner_id",
2063                  "shipment_id",
2064                  "store_id",
2065                  "status",
2066                  "bag_id",
2067                  "state_id",
2068                  "state_type",
2069                  "delivery_awb_number",
2070                  "bag_state_mapper",
2071                  "reasons",
2072                  "action_user"
2073                ]
2074              }
2075            },
2076            "fulfilling_store": {
2077              "description": "Details of the store responsible for fulfilling the order",
2078              "type": "object",
2079              "properties": {
2080                "id": {
2081                  "type": "number",
2082                  "description": "Unique identifier for the store."
2083                },
2084                "code": {
2085                  "type": "string",
2086                  "description": "Alphanumeric code representing the store."
2087                },
2088                "name": {
2089                  "type": "string",
2090                  "description": "Name of the store."
2091                },
2092                "address": {
2093                  "type": "string",
2094                  "description": "Physical address of the store."
2095                },
2096                "state": {
2097                  "type": "string",
2098                  "description": "State where the store is located."
2099                },
2100                "city": {
2101                  "type": "string",
2102                  "description": "City where the store is located."
2103                },
2104                "pincode": {
2105                  "type": "string",
2106                  "description": "Postal code (pincode) of the store's location."
2107                },
2108                "country": {
2109                  "type": "string",
2110                  "description": "Country where the store is situated."
2111                },
2112                "phone": {
2113                  "type": "string",
2114                  "description": "Contact phone number for the store."
2115                },
2116                "fulfillment_channel": {
2117                  "type": "string",
2118                  "description": "Type of fulfillment channel used by the store."
2119                },
2120                "location_type": {
2121                  "type": "string",
2122                  "enum": [
2123                    "high_street",
2124                    "mall",
2125                    "store",
2126                    "warehouse"
2127                  ],
2128                  "description": "Type of location e.g., warehouse, high_street"
2129                },
2130                "company_id": {
2131                  "type": "number",
2132                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
2133                },
2134                "is_active": {
2135                  "type": "boolean",
2136                  "description": "Boolean indicating whether the store is currently active"
2137                },
2138                "tags": {
2139                  "type": "array",
2140                  "items": {
2141                    "type": "string"
2142                  },
2143                  "description": "Array of tags associated with the store"
2144                }
2145              },
2146              "required": [
2147                "id",
2148                "code",
2149                "name",
2150                "address",
2151                "state",
2152                "city",
2153                "pincode",
2154                "country",
2155                "phone",
2156                "fulfillment_channel",
2157                "location_type",
2158                "company_id",
2159                "is_active",
2160                "tags"
2161              ]
2162            },
2163            "prices": {
2164              "type": "object",
2165              "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
2166              "properties": {
2167                "amount_paid": {
2168                  "type": "number",
2169                  "description": "Amount paid by the customer"
2170                },
2171                "refund_amount": {
2172                  "type": "number",
2173                  "description": "Amount to be refunded on cancellation and return"
2174                },
2175                "price_marked": {
2176                  "type": "number",
2177                  "description": "The indicated price or value assigned to an item before any discounts or adjustments"
2178                },
2179                "cod_charges": {
2180                  "type": "number",
2181                  "description": "The fee associated with the COD order"
2182                },
2183                "discount": {
2184                  "type": "number",
2185                  "description": "The total amount discounted from the original MRP/actual price"
2186                },
2187                "cashback_applied": {
2188                  "type": "number",
2189                  "description": "Cashback applied on the order"
2190                },
2191                "delivery_charge": {
2192                  "type": "number",
2193                  "description": "The fee associated with the delivery service for transporting the item to its destination"
2194                },
2195                "fynd_credits": {
2196                  "type": "number",
2197                  "description": "Credits provided by Fynd"
2198                },
2199                "cashback": {
2200                  "type": "number",
2201                  "description": "Cashback points"
2202                },
2203                "price_effective": {
2204                  "type": "number",
2205                  "description": "MRP - Initial Seller provided discount"
2206                },
2207                "refund_credit": {
2208                  "type": "number",
2209                  "description": "Refund credits provided to the customer"
2210                },
2211                "value_of_good": {
2212                  "type": "number",
2213                  "description": "Effective selling price - Product GST Amount"
2214                },
2215                "coupon_value": {
2216                  "type": "number",
2217                  "description": "Stores the coupon value as shown in the cart"
2218                },
2219                "tax_collected_at_source": {
2220                  "type": "number",
2221                  "description": "The tax amount collected at the source of income or transaction"
2222                },
2223                "promotion_effective_discount": {
2224                  "type": "number",
2225                  "description": "Effective promotion discount including promotions given by seller and Platform"
2226                },
2227                "fynd_promotion_effective_discount": {
2228                  "type": "number",
2229                  "description": "Promotion discount given by Platform/fynd"
2230                },
2231                "seller_promotion_effective_discount": {
2232                  "type": "number",
2233                  "description": "Promotion discount given by the seller"
2234                },
2235                "cn_refund_amount": {
2236                  "type": "number",
2237                  "description": "Amount to be refunded through credit note"
2238                },
2239                "gift_price": {
2240                  "type": "number",
2241                  "description": "Gift card amount used"
2242                },
2243                "amount_paid_roundoff": {
2244                  "type": "number",
2245                  "description": "Amount paid rounded off"
2246                }
2247              },
2248              "required": [
2249                "amount_paid",
2250                "refund_amount",
2251                "price_marked",
2252                "cod_charges",
2253                "discount",
2254                "cashback_applied",
2255                "delivery_charge",
2256                "fynd_credits",
2257                "cashback",
2258                "price_effective",
2259                "refund_credit",
2260                "value_of_good",
2261                "coupon_value",
2262                "tax_collected_at_source",
2263                "promotion_effective_discount",
2264                "fynd_promotion_effective_discount",
2265                "seller_promotion_effective_discount",
2266                "cn_refund_amount",
2267                "gift_price"
2268              ]
2269            },
2270            "payments": {
2271              "type": "object",
2272              "description": "Object containing payment mode and payment breakup",
2273              "properties": {
2274                "id": {
2275                  "type": "number",
2276                  "description": "Unique identifier for the payment mode"
2277                },
2278                "mode": {
2279                  "type": "string",
2280                  "description": "Type or category of the payment mode (e.g., PP, COD)"
2281                },
2282                "logo": {
2283                  "type": "string",
2284                  "description": "URL or path to the logo/icon representing the payment mode"
2285                },
2286                "display_name": {
2287                  "type": "string",
2288                  "description": "Name or label used to display the payment mode"
2289                },
2290                "display_priority": {
2291                  "type": "number",
2292                  "description": "Priority order for displaying the payment mode"
2293                },
2294                "source": {
2295                  "type": "string",
2296                  "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"
2297                },
2298                "is_active": {
2299                  "type": "boolean",
2300                  "description": "Boolean indicating whether the payment mode is currently active"
2301                }
2302              },
2303              "required": [
2304                "id",
2305                "mode",
2306                "logo",
2307                "display_name",
2308                "display_priority",
2309                "source",
2310                "is_active"
2311              ]
2312            },
2313            "affiliate_details": {
2314              "type": "object",
2315              "description": "Application related details like config, order_id, shipment id",
2316              "properties": {
2317                "id": {
2318                  "type": [
2319                    "string",
2320                    "number"
2321                  ],
2322                  "description": "Identifier for the application, can be application_id or extension_id"
2323                },
2324                "affiliate_bag_id": {
2325                  "type": "string",
2326                  "description": "Identifier assigned by the application for the bag"
2327                },
2328                "affiliate_order_id": {
2329                  "type": "string",
2330                  "description": "Identifier of the order assigned by the application"
2331                },
2332                "company_affiliate_tag": {
2333                  "type": "string",
2334                  "description": "Tag associated with the bag from the application's company"
2335                },
2336                "affiliate_id": {
2337                  "type": "string",
2338                  "description": "Identifier for the application, can be application_id or extension_id"
2339                },
2340                "affiliate_shipment_id": {
2341                  "type": "string",
2342                  "description": "Identifier of the shipment assigned by the application"
2343                },
2344                "affiliate_store_id": {
2345                  "type": "string",
2346                  "description": "Identifier of the store assigned by the application"
2347                },
2348                "pdf_links": {
2349                  "type": "object",
2350                  "description": "PDF Links pushed by the application or extension",
2351                  "properties": {
2352                    "label_type": {
2353                      "type": "string",
2354                      "description": "Label type - external"
2355                    },
2356                    "invoice_type": {
2357                      "type": "string",
2358                      "description": "Invoice type - external"
2359                    },
2360                    "label": {
2361                      "type": "string",
2362                      "description": "Label URL provided by the application or extension"
2363                    },
2364                    "invoice": {
2365                      "type": "string",
2366                      "description": "Invoice URL provided by the application or extension"
2367                    }
2368                  },
2369                  "required": [
2370                    "label_type",
2371                    "invoice_type"
2372                  ]
2373                },
2374                "config": {
2375                  "type": "object",
2376                  "description": "Application configuration details",
2377                  "properties": {
2378                    "id": {
2379                      "type": [
2380                        "string",
2381                        "number"
2382                      ],
2383                      "description": "Identifier for the application, can be application_id or extension_id"
2384                    },
2385                    "name": {
2386                      "type": "string",
2387                      "description": "Application name"
2388                    },
2389                    "token": {
2390                      "type": [
2391                        "null",
2392                        "string"
2393                      ],
2394                      "description": "Application token - deprecated"
2395                    },
2396                    "dp_assignment": {
2397                      "type": "boolean",
2398                      "description": "Flag indicating whether auto DP assignment should happen from system"
2399                    },
2400                    "app_company_id": {
2401                      "type": [
2402                        "number",
2403                        "null",
2404                        "string"
2405                      ],
2406                      "description": "ID of the company from which order was placed"
2407                    },
2408                    "article_assignment": {
2409                      "description": "The article assignment settings",
2410                      "type": "object",
2411                      "properties": {
2412                        "strategy": {
2413                          "type": "string",
2414                          "enum": [
2415                            "optimal",
2416                            "low-price"
2417                          ]
2418                        },
2419                        "level": {
2420                          "type": "string",
2421                          "enum": [
2422                            "multi-companies",
2423                            "single-company",
2424                            "single-store"
2425                          ]
2426                        }
2427                      },
2428                      "required": []
2429                    },
2430                    "force_reassignment": {
2431                      "type": "boolean",
2432                      "description": "Indicates whether force reassignment is enabled"
2433                    },
2434                    "sales_channel_logo": {
2435                      "type": "string",
2436                      "description": "Logo URL of the application to which order belongs"
2437                    },
2438                    "ordering_channel_logo": {
2439                      "type": "string",
2440                      "description": "Logo URL of the ordering channel"
2441                    },
2442                    "post_order_reassignment": {
2443                      "type": "boolean",
2444                      "description": "Indicates whether post-order reassignment is enabled"
2445                    }
2446                  }
2447                }
2448              },
2449              "required": [
2450                "id",
2451                "affiliate_bag_id",
2452                "affiliate_order_id",
2453                "company_affiliate_tag",
2454                "affiliate_id",
2455                "affiliate_shipment_id",
2456                "affiliate_store_id",
2457                "pdf_links",
2458                "config"
2459              ]
2460            },
2461            "dp_details": {
2462              "type": "object",
2463              "description": "Delivery Partner details",
2464              "properties": {
2465                "id": {
2466                  "type": [
2467                    "string",
2468                    "number",
2469                    "null"
2470                  ],
2471                  "description": "Unique identifier for the delivery partner"
2472                },
2473                "name": {
2474                  "type": [
2475                    "string",
2476                    "null"
2477                  ],
2478                  "description": "Name of the delivery partner"
2479                },
2480                "awb_no": {
2481                  "type": [
2482                    "string",
2483                    "null"
2484                  ],
2485                  "description": "Airway Bill (AWB) number associated with the delivery"
2486                },
2487                "eway_bill_id": {
2488                  "type": [
2489                    "string",
2490                    "null"
2491                  ],
2492                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
2493                },
2494                "track_url": {
2495                  "type": [
2496                    "string",
2497                    "null"
2498                  ],
2499                  "description": "URL to track the delivery status or shipment details"
2500                },
2501                "gst_tag": {
2502                  "type": [
2503                    "string",
2504                    "null"
2505                  ],
2506                  "description": "GST tag of the shipment"
2507                },
2508                "extension_id": {
2509                  "type": [
2510                    "string",
2511                    "null"
2512                  ],
2513                  "description": "Unique Identifier of Courier partner Extension"
2514                },
2515                "scheme_id": {
2516                  "type": [
2517                    "string",
2518                    "null"
2519                  ],
2520                  "description": "Unique identifier of a Courier partner scheme"
2521                },
2522                "courier_partner_slug": {
2523                  "type": [
2524                    "string",
2525                    "null"
2526                  ],
2527                  "description": "Unique identifier containing extension_id and scheme_id"
2528                }
2529              },
2530              "required": [
2531                "id",
2532                "name",
2533                "awb_no",
2534                "eway_bill_id",
2535                "track_url",
2536                "gst_tag",
2537                "extension_id",
2538                "scheme_id",
2539                "courier_partner_slug"
2540              ]
2541            },
2542            "rto_address": {
2543              "type": "object",
2544              "description": "The address to which shipment should be delivered in case of RTO",
2545              "properties": {
2546                "company_id": {
2547                  "type": "number",
2548                  "description": "ID of the company fulfilling the shipment"
2549                },
2550                "id": {
2551                  "type": "number",
2552                  "description": "ID of the store where RTO should happen"
2553                },
2554                "name": {
2555                  "type": "string",
2556                  "description": "A string representing the store's name"
2557                },
2558                "store_address_json": {
2559                  "type": "object",
2560                  "description": "Store address details",
2561                  "properties": {
2562                    "version": {
2563                      "type": "string",
2564                      "description": "Address version, to be deprecated"
2565                    },
2566                    "contact_person": {
2567                      "type": "string",
2568                      "description": "Name of the contact person associated with the address"
2569                    },
2570                    "address": {
2571                      "type": "string",
2572                      "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
2573                    },
2574                    "address1": {
2575                      "type": "string",
2576                      "description": "\"A string representing the first line of the address, typically containing street or building information\""
2577                    },
2578                    "address2": {
2579                      "type": "string",
2580                      "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2581                    },
2582                    "name": {
2583                      "type": "string",
2584                      "description": "A string representing the store's name"
2585                    },
2586                    "area": {
2587                      "type": "string",
2588                      "description": "A string specifying the locality or area associated with the address"
2589                    },
2590                    "area_code": {
2591                      "type": "string",
2592                      "x-not-enum": true,
2593                      "description": "Area code of the address"
2594                    },
2595                    "area_code_slug": {
2596                      "type": "string",
2597                      "description": "Unique identifier or slug for the area code associated with the address"
2598                    },
2599                    "landmark": {
2600                      "type": "string",
2601                      "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
2602                    },
2603                    "city": {
2604                      "type": "string",
2605                      "description": "A string denoting the city or municipality of the address"
2606                    },
2607                    "state": {
2608                      "type": "string",
2609                      "description": "A string indicating the state or province of the address"
2610                    },
2611                    "country": {
2612                      "type": "string",
2613                      "description": "A string indicating the country of the address"
2614                    },
2615                    "pincode": {
2616                      "type": "string",
2617                      "description": "A string indicating the postal code or PIN code of the address area"
2618                    },
2619                    "longitude": {
2620                      "type": [
2621                        "number",
2622                        "string"
2623                      ],
2624                      "description": "The longitude of the address"
2625                    },
2626                    "sector": {
2627                      "type": "string",
2628                      "description": "A string specifying the sector or district of the address if applicable"
2629                    },
2630                    "latitude": {
2631                      "type": [
2632                        "number",
2633                        "string"
2634                      ],
2635                      "description": "The latitude of the address"
2636                    },
2637                    "phone": {
2638                      "type": "string",
2639                      "description": "Mobile phone number of recipient associated with the address"
2640                    },
2641                    "email": {
2642                      "type": "string",
2643                      "description": "Email of the recipient associated with the address"
2644                    },
2645                    "address_type": {
2646                      "type": "string",
2647                      "x-not-enum": true,
2648                      "description": "Type of address (e.g., home, office, registered)"
2649                    },
2650                    "address_category": {
2651                      "type": "string",
2652                      "x-not-enum": true,
2653                      "description": "Category or classification of the address"
2654                    },
2655                    "created_at": {
2656                      "type": "string",
2657                      "format": "date-time",
2658                      "description": "Date and time when the address was created"
2659                    },
2660                    "updated_at": {
2661                      "type": "string",
2662                      "format": "date-time",
2663                      "description": "Date and time when the address was last updated"
2664                    },
2665                    "country_phone_code": {
2666                      "type": [
2667                        "string",
2668                        "null"
2669                      ],
2670                      "x-not-enum": true,
2671                      "description": "Phone code for the country of the address"
2672                    },
2673                    "country_iso_code": {
2674                      "type": "string",
2675                      "x-not-enum": true,
2676                      "description": "ISO code representing the country of the address"
2677                    },
2678                    "country_code": {
2679                      "type": "string",
2680                      "x-not-enum": true,
2681                      "description": "ISO code representing the country of the address"
2682                    },
2683                    "display_address": {
2684                      "type": "string",
2685                      "description": "Formatted display version of the address"
2686                    }
2687                  }
2688                },
2689                "code": {
2690                  "type": "string",
2691                  "description": "Alphanumeric code representing the store"
2692                },
2693                "location_type": {
2694                  "type": "string",
2695                  "x-not-enum": true,
2696                  "description": "Type of location e.g., warehouse, high_street"
2697                },
2698                "address1": {
2699                  "type": "string",
2700                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
2701                },
2702                "address2": {
2703                  "type": "string",
2704                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2705                },
2706                "display_address": {
2707                  "type": "string",
2708                  "description": "Formatted display version of the address"
2709                },
2710                "city": {
2711                  "type": "string",
2712                  "description": "A string denoting the city or municipality of the address"
2713                },
2714                "state": {
2715                  "type": "string",
2716                  "description": "A string indicating the state or province of the address"
2717                },
2718                "sector": {
2719                  "type": "string",
2720                  "description": "A string specifying the sector or district of the address if applicable"
2721                },
2722                "country": {
2723                  "type": "string",
2724                  "description": "A string indicating the country of the address"
2725                },
2726                "pincode": {
2727                  "type": "string",
2728                  "description": "A string indicating the postal code or PIN code of the address area"
2729                },
2730                "store_email": {
2731                  "type": "string",
2732                  "description": "Email of the recipient associated with the store"
2733                },
2734                "contact_person": {
2735                  "type": "string",
2736                  "description": "Name of the contact person associated with the address"
2737                },
2738                "phone": {
2739                  "type": "string",
2740                  "description": "Mobile phone number of recipient associated with the address"
2741                }
2742              },
2743              "required": [
2744                "company_id",
2745                "id",
2746                "name",
2747                "store_address_json",
2748                "code",
2749                "location_type",
2750                "address1",
2751                "address2",
2752                "display_address",
2753                "city",
2754                "state",
2755                "sector",
2756                "country",
2757                "pincode",
2758                "store_email",
2759                "contact_person",
2760                "phone"
2761              ]
2762            },
2763            "weight": {
2764              "type": "object",
2765              "description": "Shipment weight",
2766              "properties": {
2767                "value": {
2768                  "type": "number"
2769                },
2770                "unit": {
2771                  "type": "string"
2772                }
2773              },
2774              "required": [
2775                "value",
2776                "unit"
2777              ]
2778            },
2779            "shipment_gst": {
2780              "type": "object",
2781              "description": "GST details associated with the shipment",
2782              "properties": {
2783                "value_of_good": {
2784                  "type": "number",
2785                  "description": "Effective selling price - Product GST Amount"
2786                },
2787                "gst_fee": {
2788                  "type": "number",
2789                  "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
2790                },
2791                "brand_calculated_amount": {
2792                  "type": "number",
2793                  "description": "Effective selling price  - Brand's additional discounts"
2794                },
2795                "tax_collected_at_source": {
2796                  "type": "number",
2797                  "description": "The tax amount collected at the source of income or transaction"
2798                },
2799                "gstin_code": {
2800                  "type": [
2801                    "string",
2802                    "null"
2803                  ],
2804                  "x-not-enum": true,
2805                  "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
2806                }
2807              },
2808              "required": [
2809                "value_of_good",
2810                "gst_fee",
2811                "brand_calculated_amount",
2812                "tax_collected_at_source",
2813                "gstin_code"
2814              ]
2815            },
2816            "store_invoice_id": {
2817              "type": [
2818                "string",
2819                "null"
2820              ],
2821              "description": "Invoice ID attached to the shipment"
2822            },
2823            "credit_note_id": {
2824              "type": [
2825                "string",
2826                "null"
2827              ],
2828              "description": "Credit Note ID attached to the shipment"
2829            },
2830            "order_created": {
2831              "type": "string",
2832              "description": "Order creation timestamp"
2833            },
2834            "payment_methods": {
2835              "type": "object",
2836              "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
2837            },
2838            "payment_info": {
2839              "type": "array",
2840              "description": "\"Array of object containing payment methods used for placing an order.\"",
2841              "items": {}
2842            },
2843            "order": {
2844              "type": "object",
2845              "description": "Order level details",
2846              "properties": {
2847                "ordering_channel": {
2848                  "type": "string",
2849                  "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
2850                },
2851                "ordering_source": {
2852                  "type": "string",
2853                  "nullable": true,
2854                  "description": "To uniquely identify the source through which order has been placed.",
2855                  "enum": [
2856                    "storefront",
2857                    "store_os_pos",
2858                    "kiosk",
2859                    "scan_go",
2860                    "smart_trolley",
2861                    "gofynd",
2862                    "uniket",
2863                    "marketplace",
2864                    "social_commerce",
2865                    "ondc",
2866                    "nexus"
2867                  ]
2868                },
2869                "affiliate_order_date": {
2870                  "type": [
2871                    "string",
2872                    "null"
2873                  ],
2874                  "format": "date-time",
2875                  "description": "Order creation timestamp at application/extension end"
2876                },
2877                "affiliate_order_id": {
2878                  "type": "string",
2879                  "description": "Identifier of the order assigned by the application"
2880                },
2881                "fynd_order_id": {
2882                  "type": "string",
2883                  "description": "System generated unique identifier of the order"
2884                },
2885                "mode_of_payment": {
2886                  "type": "string",
2887                  "description": "Unique identifier associated with the payment mode"
2888                },
2889                "source": {
2890                  "type": "string",
2891                  "description": "Ordering source eg. affiliate, fynd"
2892                },
2893                "total_order_value": {
2894                  "type": "number",
2895                  "description": "Total order value"
2896                },
2897                "collect_by": {
2898                  "type": "string",
2899                  "description": "Whomsoever collected the money"
2900                },
2901                "refund_by": {
2902                  "type": "string",
2903                  "description": "Whomsoever will refund the money"
2904                },
2905                "order_value": {
2906                  "type": "number",
2907                  "description": "Value of the order"
2908                }
2909              },
2910              "required": [
2911                "ordering_channel",
2912                "affiliate_order_date",
2913                "affiliate_order_id",
2914                "fynd_order_id",
2915                "mode_of_payment",
2916                "source",
2917                "total_order_value",
2918                "collect_by",
2919                "refund_by",
2920                "order_value"
2921              ]
2922            },
2923            "order_source": {
2924              "type": "string",
2925              "description": "Ordering source eg. affiliate, fynd"
2926            },
2927            "journey_type": {
2928              "type": [
2929                "string",
2930                "null"
2931              ],
2932              "description": "Journey type forward or return"
2933            },
2934            "einvoice_info": {
2935              "type": "object",
2936              "description": "Einvoice info if e-invoice is applicable",
2937              "properties": {
2938                "credit_note": {
2939                  "description": "Details of the reverse credit note einvoice",
2940                  "type": "object",
2941                  "properties": {
2942                    "ack_dt": {
2943                      "type": "string",
2944                      "description": "Date and time when the e-invoice acknowledgment was received"
2945                    },
2946                    "ack_no": {
2947                      "type": "string",
2948                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
2949                    },
2950                    "irn": {
2951                      "type": "string",
2952                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
2953                    },
2954                    "signed_invoice": {
2955                      "type": "string",
2956                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
2957                    },
2958                    "signed_qr_code": {
2959                      "x-not-enum": true,
2960                      "type": "string",
2961                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
2962                    },
2963                    "message": {
2964                      "type": "array",
2965                      "description": "Error Message received from JioGSt",
2966                      "items": {
2967                        "type": "object",
2968                        "properties": {
2969                          "ErrorCode": {
2970                            "type": [
2971                              "string",
2972                              "null"
2973                            ]
2974                          },
2975                          "ErrorMessage": {
2976                            "type": [
2977                              "string",
2978                              "null"
2979                            ]
2980                          }
2981                        }
2982                      }
2983                    }
2984                  }
2985                },
2986                "invoice": {
2987                  "description": "Details of the forward invoice einvoice",
2988                  "type": "object",
2989                  "properties": {
2990                    "ack_dt": {
2991                      "type": "string",
2992                      "description": "Date and time when the e-invoice acknowledgment was received"
2993                    },
2994                    "ack_no": {
2995                      "type": "string",
2996                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
2997                    },
2998                    "irn": {
2999                      "type": "string",
3000                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
3001                    },
3002                    "signed_invoice": {
3003                      "type": "string",
3004                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
3005                    },
3006                    "signed_qr_code": {
3007                      "x-not-enum": true,
3008                      "type": "string",
3009                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
3010                    },
3011                    "message": {
3012                      "type": "array",
3013                      "description": "Error Message received from JioGSt",
3014                      "items": {
3015                        "type": "object",
3016                        "properties": {
3017                          "ErrorCode": {
3018                            "type": [
3019                              "string",
3020                              "null"
3021                            ]
3022                          },
3023                          "ErrorMessage": {
3024                            "type": [
3025                              "string",
3026                              "null"
3027                            ]
3028                          }
3029                        }
3030                      }
3031                    }
3032                  }
3033                }
3034              },
3035              "required": []
3036            },
3037            "lock_status": {
3038              "type": "boolean",
3039              "description": "Lock status of the shipment"
3040            },
3041            "original_bag_list": {
3042              "type": "array",
3043              "items": {
3044                "type": "number"
3045              },
3046              "description": "List of Bag ids when the order was created"
3047            },
3048            "shipment_update_time": {
3049              "type": "number",
3050              "description": "Last shipment update time"
3051            },
3052            "previous_shipment_id": {
3053              "type": [
3054                "string",
3055                "null"
3056              ],
3057              "description": "\"ID of the shipment from which current shipment was created,  this is populated whenever the shipment goes into negative state transition\""
3058            },
3059            "fyndstore_emp": {
3060              "type": "object",
3061              "description": "Fynd store employee details",
3062              "properties": {},
3063              "required": []
3064            },
3065            "ordering_store": {
3066              "description": "Store details from which order was placed in case of StoreOS",
3067              "required": [],
3068              "type": "object",
3069              "properties": {
3070                "id": {
3071                  "type": "number",
3072                  "description": "Unique identifier for the store."
3073                },
3074                "code": {
3075                  "type": "string",
3076                  "description": "Alphanumeric code representing the store."
3077                },
3078                "name": {
3079                  "type": "string",
3080                  "description": "Name of the store."
3081                },
3082                "address": {
3083                  "type": "string",
3084                  "description": "Physical address of the store."
3085                },
3086                "state": {
3087                  "type": "string",
3088                  "description": "State where the store is located."
3089                },
3090                "city": {
3091                  "type": "string",
3092                  "description": "City where the store is located."
3093                },
3094                "pincode": {
3095                  "type": "string",
3096                  "description": "Postal code (pincode) of the store's location."
3097                },
3098                "country": {
3099                  "type": "string",
3100                  "description": "Country where the store is situated."
3101                },
3102                "phone": {
3103                  "type": "string",
3104                  "description": "Contact phone number for the store."
3105                },
3106                "fulfillment_channel": {
3107                  "type": "string",
3108                  "description": "Type of fulfillment channel used by the store."
3109                },
3110                "location_type": {
3111                  "type": "string",
3112                  "enum": [
3113                    "high_street",
3114                    "mall",
3115                    "store",
3116                    "warehouse"
3117                  ],
3118                  "description": "Type of location e.g., warehouse, high_street"
3119                },
3120                "company_id": {
3121                  "type": "number",
3122                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
3123                },
3124                "is_active": {
3125                  "type": "boolean",
3126                  "description": "Boolean indicating whether the store is currently active"
3127                },
3128                "tags": {
3129                  "type": "array",
3130                  "items": {
3131                    "type": "string"
3132                  },
3133                  "description": "Array of tags associated with the store"
3134                }
3135              }
3136            },
3137            "coupon": {
3138              "type": "object",
3139              "description": "Coupon related details",
3140              "properties": {},
3141              "required": []
3142            },
3143            "cart_info": {
3144              "type": "object",
3145              "description": "Cart related information",
3146              "properties": {
3147                "cart_id": {
3148                  "type": "string",
3149                  "description": "The unique identifier of the cart"
3150                },
3151                "cart_uid": {
3152                  "type": "number",
3153                  "description": "UID associated with the cart"
3154                }
3155              },
3156              "required": [
3157                "cart_id",
3158                "cart_uid"
3159              ]
3160            }
3161          },
3162          "required": [
3163            "status",
3164            "shipment_status",
3165            "application_id",
3166            "shipment_id",
3167            "company_id",
3168            "app_company_id",
3169            "order_id",
3170            "merchant_id",
3171            "user",
3172            "delivery_address",
3173            "billing_address",
3174            "delivery_partner_details",
3175            "bags",
3176            "bag_status_history",
3177            "fulfilling_store",
3178            "prices",
3179            "payments",
3180            "affiliate_details",
3181            "dp_details",
3182            "rto_address",
3183            "weight",
3184            "shipment_gst",
3185            "store_invoice_id",
3186            "credit_note_id",
3187            "order_created",
3188            "payment_methods",
3189            "payment_info",
3190            "order",
3191            "order_source",
3192            "journey_type",
3193            "einvoice_info",
3194            "lock_status",
3195            "original_bag_list",
3196            "shipment_update_time",
3197            "previous_shipment_id",
3198            "fyndstore_emp",
3199            "ordering_store",
3200            "coupon",
3201            "cart_info"
3202          ]
3203        }
3204      },
3205      "required": [
3206        "shipment"
3207      ]
3208    }
3209  }
3210}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "0000000000000000fcb9acdea07f86c1"
5    ],
6    "name": "shipment",
7    "type": "data_update",
8    "version": "1",
9    "created_timestamp": 1711863902491,
10    "id": "QsOwO98GEZml5dGw/vScF+Z+xHnDdgfSqRVjMMY/N/k=",
11    "category": "application"
12  },
13  "company_id": 46,
14  "application_id": "614b42d1ea943427b5f46d1e",
15  "contains": [
16    "shipment"
17  ],
18  "payload": {
19    "shipment": {
20      "status": "ready_for_dp_assignment",
21      "shipment_status": {
22        "bag_list": [
23          "33844742",
24          "33844743"
25        ],
26        "id": 163969392,
27        "updated_ts": "2024-03-31T05:45:02Z",
28        "shipment_id": "17118062289491816415",
29        "created_at": "2024-03-31T11:15:02+00:00",
30        "created_ts": "2024-03-31T05:45:02Z",
31        "meta": {
32          "request_meta": {},
33          "estimated_sla_ts": "2024-04-01T13:43:48Z",
34          "estimated_sla_time": "2024-04-01T19:13:48+05:30",
35          "state_manager_used": "entity"
36        },
37        "status": "ready_for_dp_assignment",
38        "current_shipment_status": "ready_for_dp_assignment",
39        "status_created_at": "2024-03-31T11:15:02+00:00"
40      },
41      "application_id": "614b42d1ea943427b5f46d1e",
42      "shipment_id": "17118062289491816415",
43      "company_id": 46,
44      "app_company_id": 46,
45      "order_id": "FY660817140E6E656DB9",
46      "merchant_id": "",
47      "user": {
48        "gender": null,
49        "email": "test@example.com",
50        "id": null,
51        "mongo_user_id": null,
52        "external_customer_id": "",
53        "first_name": "",
54        "user_oid": null,
55        "meta": null,
56        "last_name": "",
57        "mobile": null,
58        "is_anonymous_user": true
59      },
60      "delivery_address": {
61        "area": "test area",
62        "city": "South Delhi",
63        "meta": {
64          "area_code": "110017",
65          "area_code_slug": "pincode"
66        },
67        "name": "test name",
68        "email": "test@example.com",
69        "phone": "1111111111",
70        "state": "Delhi",
71        "address": "test address",
72        "country": "India",
73        "pincode": "110017",
74        "user_id": null,
75        "version": "1.0",
76        "address1": "test address",
77        "address2": "",
78        "landmark": "",
79        "latitude": 0,
80        "area_code": "110017",
81        "longitude": 0,
82        "created_at": "2024-03-30T19:13:48+00:00",
83        "updated_at": "2024-03-30T19:13:48+00:00",
84        "address_type": "home",
85        "country_code": "IN",
86        "geo_location": {},
87        "area_code_slug": "pincode",
88        "contact_person": "test user",
89        "display_address": "test address",
90        "address_category": "",
91        "country_iso_code": "IN",
92        "country_phone_code": null
93      },
94      "billing_address": {
95        "area": "test area",
96        "city": "Delhi",
97        "meta": {
98          "area_code": "110017",
99          "area_code_slug": "pincode"
100        },
101        "name": "test user",
102        "email": "test@example.com",
103        "phone": "1111111111",
104        "state": "DELHI",
105        "address": "test address",
106        "country": "India",
107        "pincode": "110017",
108        "user_id": null,
109        "version": "1.0",
110        "address1": "test address",
111        "address2": "",
112        "landmark": "",
113        "latitude": 0,
114        "area_code": "110017",
115        "longitude": 0,
116        "created_at": "2024-03-30 19:13:48",
117        "updated_at": "2024-03-30 19:13:48",
118        "address_type": "home",
119        "country_code": "IN",
120        "geo_location": {},
121        "area_code_slug": "pincode",
122        "contact_person": "dummy user",
123        "display_address": "test address",
124        "address_category": "",
125        "country_iso_code": "IN",
126        "country_phone_code": null
127      },
128      "delivery_partner_details": {
129        "id": null,
130        "name": null,
131        "awb_no": null,
132        "eway_bill_id": null,
133        "track_url": null,
134        "gst_tag": "sgst",
135        "extension_id": null,
136        "scheme_id": null,
137        "courier_partner_slug": null
138      },
139      "bags": [
140        {
141          "financial_breakup": [
142            {
143              "brand_calculated_amount": 1397,
144              "discount": 1398,
145              "gst_fee": 149.68,
146              "gst_tax_percentage": 12,
147              "gst_tag": "IGST",
148              "hsn_code": "62111200",
149              "identifiers": {
150                "alu": "000000410255726014"
151              },
152              "price_marked": 2795,
153              "tax_collected_at_source": 0,
154              "tcs_percentage": 0,
155              "total_units": 1,
156              "value_of_good": 1247.32,
157              "item_name": "Scallop Goddess Plunge PU",
158              "size": "32A"
159            }
160          ],
161          "entity_type": "bag",
162          "item": {
163            "gender": null,
164            "id": 1186480,
165            "color": null,
166            "webstore_product_url": null,
167            "l2_category_id": 24,
168            "branch_url": "https://go.fyndi.ng/zNzR6WNcx3",
169            "name": "Scallop Goddess Plunge PU",
170            "brand": "Hunkemoller",
171            "can_cancel": true,
172            "brand_id": 356,
173            "code": "166801NERO",
174            "slug_key": "hunkemoller-black-bikini-scallop-goddess-plunge-top-1186480-fdf824",
175            "l1_category_id": 442,
176            "l2_category": [
177              "Beachwear & Swimwear"
178            ],
179            "meta": {
180              "tags": [
181                "Swimwear",
182                "B2B3"
183              ],
184              "departments": [
185                21
186              ]
187            },
188            "last_updated_at": "2024-03-30T19:13:49+00:00",
189            "attributes": {
190              "name": "Scallop Goddess Plunge PU",
191              "color": "Black",
192              "gender": [
193                "Women"
194              ],
195              "season": "SS20",
196              "pattern": "Solid",
197              "material": "95% Polyamide, 5% Elastane",
198              "occasion": "Casual",
199              "essential": "No",
200              "brand_name": "Hunkemoller",
201              "net-quantity": "1 N",
202              "marketer-name": "Reliance Brands Limited",
203              "primary_color": "Black",
204              "marketer-address": "test address",
205              "primary_material": "Polyester",
206              "primary_color_hex": "000000",
207              "primary-colour-hex-code": "000000",
208              "media": []
209            },
210            "can_return": true,
211            "l3_category": 1370,
212            "l3_category_name": "Beachwear Bikini Tops",
213            "l1_category": [
214              "Clothing"
215            ],
216            "department_id": 21,
217            "size": "32A",
218            "image": [
219              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/Jc1KtK-mUOG-410255726003_1.jpg",
220              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/CDcXFczdYb8-410255726003_2.jpg",
221              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/cgemmtRjD-410255726003_3.jpg",
222              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/YIs0m4K3Px-410255726003_4.jpg",
223              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/8FaVpjBLcz-410255726003_5.jpg",
224              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255726003/_vM4sgtYkL-410255726003_6.jpg"
225            ]
226          },
227          "brand": {
228            "credit_note_allowed": false,
229            "brand_name": "Hunkemoller",
230            "id": 356,
231            "modified_on": "2023-06-20T18:49:25+00:00",
232            "is_virtual_invoice": false,
233            "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/1129_43ac065d3d9f43c6b5adddcb33294e77.jpg",
234            "created_on": "2017-02-08T13:40:44+00:00"
235          },
236          "bag_id": 33844742,
237          "article": {
238            "identifiers": {
239              "alu": "000000410255726014"
240            },
241            "esp_modified": false,
242            "size": "32A",
243            "code": "",
244            "raw_meta": null,
245            "set": {},
246            "is_set": false,
247            "seller_identifier": "000000410255726014",
248            "return_config": {
249              "time": 30,
250              "unit": "days",
251              "returnable": true
252            },
253            "_id": "630de4e5ea54210bdddf2882",
254            "uid": "630de4e5ea54210bdddf2882",
255            "child_details": {},
256            "dimensions": {
257              "unit": "cm",
258              "width": 17,
259              "height": 8,
260              "length": 27.5,
261              "is_default": true
262            },
263            "weight": {
264              "unit": "gram",
265              "shipping": 100,
266              "is_default": true
267            },
268            "currency": {
269              "code": "INR",
270              "rate": 1
271            },
272            "expiration_date": "9998-01-30 23:59:00"
273          },
274          "current_operational_status": {
275            "id": 216808130,
276            "updated_ts": "2024-03-31T05:45:02Z",
277            "kafka_sync": false,
278            "shipment_id": "17118062289491816415",
279            "state_type": "operational",
280            "state_id": 113,
281            "updated_at": "2024-03-31T11:15:02+00:00",
282            "bag_id": 33844742,
283            "created_at": "2024-03-31T11:15:02+00:00",
284            "delivery_awb_number": null,
285            "delivery_partner_id": null,
286            "created_ts": "2024-03-31T05:45:02Z",
287            "store_id": 14406,
288            "status": "ready_for_dp_assignment",
289            "bag_state_mapper": {
290              "journey_type": "forward",
291              "app_display_name": "Ready For Dp Assignment",
292              "state_type": "operational",
293              "app_state_name": "ready_for_dp_assignment",
294              "name": "ready_for_dp_assignment",
295              "app_facing": false,
296              "id": 113,
297              "display_name": "Ready For Dp Assignment",
298              "notify_customer": false,
299              "is_active": true
300            },
301            "reasons": [],
302            "action_user": {}
303          },
304          "affiliate_bag_details": {
305            "affiliate_bag_id": "33844742",
306            "affiliate_order_id": "251640",
307            "affiliate_meta": {
308              "fynd": {
309                "fulfilment_identifier": "pulse",
310                "fulfilment_identifiers_list": [
311                  "pulse"
312                ]
313              },
314              "channel_shipment_id": null,
315              "channel_order_id": null,
316              "due_date": null,
317              "is_priority": false,
318              "box_type": null,
319              "coupon_code": "",
320              "size_level_total_qty": 1,
321              "loyalty_discount": 0,
322              "employee_discount": 0
323            },
324            "loyalty_discount": 0,
325            "employee_discount": 0
326          },
327          "payment_methods": {
328            "PP": {
329              "amount": 1397
330            }
331          },
332          "quantity": 1,
333          "prices": {
334            "price_effective": 1397,
335            "discount": 1398,
336            "amount_paid": 1397,
337            "coupon_effective_discount": 0,
338            "delivery_charge": 0,
339            "fynd_credits": 0,
340            "cod_charges": 0,
341            "refund_credit": 0,
342            "cashback": 0,
343            "refund_amount": 1397,
344            "added_to_fynd_cash": false,
345            "cashback_applied": 0,
346            "gst_tax_percentage": 12,
347            "value_of_good": 1247.32,
348            "price_marked": 2795,
349            "transfer_price": 0,
350            "brand_calculated_amount": 1397,
351            "tax_collected_at_source": 0,
352            "tcs_percentage": 0,
353            "promotion_effective_discount": 0,
354            "gift_price": 0,
355            "coupon_value": 0,
356            "seller_promotion_effective_discount": 0,
357            "fynd_promotion_effective_discount": 0,
358            "amount_paid_roundoff": 1397
359          },
360          "order_created": "2024-03-30T19:13:49+00:00",
361          "gst_details": {
362            "gstin_code": "06AADCR7395F1Z4",
363            "gst_tag": "IGST",
364            "hsn_code": "62111200",
365            "value_of_good": 1247.32,
366            "gst_tax_percentage": 12,
367            "is_default_hsn_code": false,
368            "brand_calculated_amount": 1397,
369            "tax_collected_at_source": 0,
370            "hsn_code_id": "627783925e4c6fdbc8be40c7",
371            "gst_fee": 149.68,
372            "igst_tax_percentage": 12,
373            "sgst_tax_percentage": 0,
374            "cgst_tax_percentage": 0,
375            "igst_gst_fee": 149.68,
376            "cgst_gst_fee": "0",
377            "sgst_gst_fee": "0"
378          },
379          "line_number": 1,
380          "applied_promos": [],
381          "meta": {
382            "group_id": "",
383            "gift_card": {
384              "gift_price": 0,
385              "display_text": "",
386              "is_gift_applied": false
387            },
388            "extra_meta": {
389              "price_marked": "2795.00",
390              "price_effective": 1397
391            },
392            "_custom_json": {
393              "_display": []
394            },
395            "docket_number": "171180622894918164151",
396            "partial_can_ret": false,
397            "country_of_origin": "China",
398            "parent_docket_number": "171180622894918164151",
399            "product_discount_applied": {
400              "_id": "65f2c7c5352864fccbd0b7b5",
401              "job_id": "65f2c7aba17754320ad4f33c",
402              "app_ids": [
403                "614b42d1ea943427b5f46d1e"
404              ],
405              "item_id": 1186480,
406              "discount": [
407                {
408                  "value": 50,
409                  "min_items": 1
410                }
411              ],
412              "zone_ids": [],
413              "abandoned": false,
414              "brand_ids": [
415                356
416              ],
417              "company_id": 46,
418              "created_on": "2024-03-14T13:49:02.698000",
419              "modified_on": "2024-03-14T13:49:02.698000",
420              "discount_job": {
421                "_id": "65f2c7aba17754320ad4f33c",
422                "meta": {
423                  "triggerhappyEndJob": "65f3003562b57f4a495ca54f",
424                  "triggerhappyStartJob": "65f3003562b57f779c5ca54e"
425                },
426                "name": "HKM BRA PARTY FLAT 50% OFF",
427                "value": null,
428                "app_ids": [
429                  "614b42d1ea943427b5f46d1e"
430                ],
431                "job_type": "app|brand|inventory",
432                "validity": {
433                  "end": "2024-04-29T18:30:00",
434                  "start": "2024-03-14T18:50:00"
435                },
436                "zone_ids": [],
437                "brand_ids": [
438                  356
439                ],
440                "file_path": "/company/46/self/documents/product-import/free/original/KlA4KBqfk-50percent-off.xlsx",
441                "is_active": true,
442                "company_id": 46,
443                "created_by": {
444                  "user_id": "23542762",
445                  "username": "test_example_com_12345"
446                },
447                "created_on": "2024-03-14T09:47:23.981000",
448                "modified_by": {
449                  "user_id": "23542762",
450                  "username": "test_example_com_12345"
451                },
452                "modified_on": "2024-03-14T18:50:00.061000",
453                "discount_meta": {
454                  "hours": 0,
455                  "timer": false,
456                  "minutes": 0
457                },
458                "discount_type": "percentage",
459                "discount_level": "application"
460              },
461              "discount_meta": {
462                "end": "2024-04-29T18:30:00Z",
463                "start": "2024-03-14T18:50:00Z",
464                "timer": false
465              },
466              "discount_type": "percentage",
467              "seller_identifier": "000000410255726014"
468            },
469            "delivery_charges_hsn_code": "996819",
470            "multi_quantity_bag_enabled": false
471          }
472        },
473        {
474          "financial_breakup": [
475            {
476              "brand_calculated_amount": 697,
477              "discount": 698,
478              "gst_fee": 33.19,
479              "gst_tax_percentage": 5,
480              "gst_tag": "IGST",
481              "hsn_code": "61124100",
482              "identifiers": {
483                "alu": "000000410255725001"
484              },
485              "price_marked": 1395,
486              "tax_collected_at_source": 0,
487              "tcs_percentage": 0,
488              "total_units": 1,
489              "value_of_good": 663.81,
490              "item_name": "Black Scallop Goddess Cheeky Tanga Bikini",
491              "size": "XS"
492            }
493          ],
494          "entity_type": "bag",
495          "item": {
496            "gender": null,
497            "id": 1182446,
498            "color": null,
499            "webstore_product_url": null,
500            "l2_category_id": 24,
501            "branch_url": "https://go.fyndi.ng/6nG85zkFm3",
502            "name": "Black Scallop Goddess Cheeky Tanga Bikini",
503            "brand": "Hunkemoller",
504            "can_cancel": true,
505            "brand_id": 356,
506            "code": "166804NERO",
507            "slug_key": "hunkemoller-black-scallop-goddess-cheeky-tanga-bikini-1182446-d314d7",
508            "l1_category_id": 442,
509            "l2_category": [
510              "Beachwear & Swimwear"
511            ],
512            "meta": {
513              "tags": [
514                "Swimwear",
515                "B2B3"
516              ],
517              "departments": [
518                21
519              ]
520            },
521            "last_updated_at": "2024-03-30T19:13:49+00:00",
522            "attributes": {
523              "name": "Black Scallop Goddess Cheeky Tanga Bikini",
524              "color": "Black",
525              "gender": [
526                "Women"
527              ],
528              "season": "SS20",
529              "pattern": "Solid",
530              "material": "95% Polyamide, 5% Elastane",
531              "occasion": "Casual",
532              "essential": "No",
533              "brand_name": "Hunkemoller",
534              "net-quantity": "1 N",
535              "marketer-name": "Reliance Brands Limited",
536              "primary_color": "Black",
537              "marketer-address": "test address",
538              "primary_material": "Nylon",
539              "primary_color_hex": "000000",
540              "primary-colour-hex-code": "000000",
541              "media": []
542            },
543            "can_return": true,
544            "l3_category": 333,
545            "l3_category_name": "Bikinis",
546            "l1_category": [
547              "Clothing"
548            ],
549            "department_id": 21,
550            "size": "XS",
551            "image": [
552              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/Tb8em-hRR-E-410255725001_1.jpg",
553              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/NmHExkPARVI-410255725001_2.jpg",
554              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/ALSV0ovgBsx-410255725001_3.jpg",
555              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/vGybxj3vi3f-410255725001_4.jpg",
556              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/KM1KPWS7gIk-410255725001_5.jpg",
557              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/NmHExkPARVI-410255725001_2.jpg",
558              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/ALSV0ovgBsx-410255725001_3.jpg",
559              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/vGybxj3vi3f-410255725001_4.jpg",
560              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/000000410255725001/KM1KPWS7gIk-410255725001_5.jpg"
561            ]
562          },
563          "brand": {
564            "credit_note_allowed": false,
565            "brand_name": "Hunkemoller",
566            "id": 356,
567            "modified_on": "2023-06-20T18:49:25+00:00",
568            "is_virtual_invoice": false,
569            "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/1129_43ac065d3d9f43c6b5adddcb33294e77.jpg",
570            "created_on": "2017-02-08T13:40:44+00:00"
571          },
572          "bag_id": 33844743,
573          "article": {
574            "identifiers": {
575              "alu": "000000410255725001"
576            },
577            "esp_modified": false,
578            "size": "XS",
579            "code": "",
580            "raw_meta": null,
581            "set": {},
582            "is_set": false,
583            "seller_identifier": "000000410255725001",
584            "return_config": {
585              "time": 0,
586              "unit": "days",
587              "returnable": false
588            },
589            "_id": "62842a1b68812ee2b6d0b9d9",
590            "uid": "62842a1b68812ee2b6d0b9d9",
591            "child_details": {},
592            "dimensions": {
593              "unit": "cm",
594              "width": 17,
595              "height": 8,
596              "length": 27.5,
597              "is_default": true
598            },
599            "weight": {
600              "unit": "gram",
601              "shipping": 100,
602              "is_default": true
603            },
604            "currency": {
605              "code": "INR",
606              "rate": 1
607            },
608            "expiration_date": "9998-01-30 23:59:00"
609          },
610          "current_operational_status": {
611            "id": 216808131,
612            "updated_ts": "2024-03-31T05:45:02Z",
613            "kafka_sync": false,
614            "shipment_id": "17118062289491816415",
615            "state_type": "operational",
616            "state_id": 113,
617            "updated_at": "2024-03-31T11:15:02+00:00",
618            "bag_id": 33844743,
619            "created_at": "2024-03-31T11:15:02+00:00",
620            "delivery_awb_number": null,
621            "delivery_partner_id": null,
622            "created_ts": "2024-03-31T05:45:02Z",
623            "store_id": 14406,
624            "status": "ready_for_dp_assignment",
625            "bag_state_mapper": {
626              "journey_type": "forward",
627              "app_display_name": "Ready For Dp Assignment",
628              "state_type": "operational",
629              "app_state_name": "ready_for_dp_assignment",
630              "name": "ready_for_dp_assignment",
631              "app_facing": false,
632              "id": 113,
633              "display_name": "Ready For Dp Assignment",
634              "notify_customer": false,
635              "is_active": true
636            },
637            "reasons": [],
638            "action_user": {}
639          },
640          "affiliate_bag_details": {
641            "affiliate_bag_id": "33844743",
642            "affiliate_order_id": "251640",
643            "affiliate_meta": {
644              "fynd": {
645                "fulfilment_identifier": "pulse",
646                "fulfilment_identifiers_list": [
647                  "pulse"
648                ]
649              },
650              "channel_shipment_id": null,
651              "channel_order_id": null,
652              "due_date": null,
653              "is_priority": false,
654              "box_type": null,
655              "coupon_code": "",
656              "size_level_total_qty": 1,
657              "loyalty_discount": 0,
658              "employee_discount": 0
659            },
660            "loyalty_discount": 0,
661            "employee_discount": 0
662          },
663          "payment_methods": {
664            "PP": {
665              "amount": 697
666            }
667          },
668          "quantity": 1,
669          "prices": {
670            "price_effective": 697,
671            "discount": 698,
672            "amount_paid": 697,
673            "coupon_effective_discount": 0,
674            "delivery_charge": 0,
675            "fynd_credits": 0,
676            "cod_charges": 0,
677            "refund_credit": 0,
678            "cashback": 0,
679            "refund_amount": 697,
680            "added_to_fynd_cash": false,
681            "cashback_applied": 0,
682            "gst_tax_percentage": 5,
683            "value_of_good": 663.81,
684            "price_marked": 1395,
685            "transfer_price": 0,
686            "brand_calculated_amount": 697,
687            "tax_collected_at_source": 0,
688            "tcs_percentage": 0,
689            "promotion_effective_discount": 0,
690            "gift_price": 0,
691            "coupon_value": 0,
692            "seller_promotion_effective_discount": 0,
693            "fynd_promotion_effective_discount": 0,
694            "amount_paid_roundoff": 697
695          },
696          "order_created": "2024-03-30T19:13:49+00:00",
697          "gst_details": {
698            "gstin_code": "06AADCR7395F1Z4",
699            "gst_tag": "IGST",
700            "hsn_code": "61124100",
701            "value_of_good": 663.81,
702            "gst_tax_percentage": 5,
703            "is_default_hsn_code": false,
704            "brand_calculated_amount": 697,
705            "tax_collected_at_source": 0,
706            "hsn_code_id": "627783865e4c6fdbc8be3f98",
707            "gst_fee": 33.19,
708            "igst_tax_percentage": 5,
709            "sgst_tax_percentage": 0,
710            "cgst_tax_percentage": 0,
711            "igst_gst_fee": 33.19,
712            "cgst_gst_fee": "0",
713            "sgst_gst_fee": "0"
714          },
715          "line_number": 2,
716          "applied_promos": [],
717          "meta": {
718            "group_id": "",
719            "gift_card": {
720              "gift_price": 0,
721              "display_text": "",
722              "is_gift_applied": false
723            },
724            "extra_meta": {
725              "price_marked": "1395.00",
726              "price_effective": 697
727            },
728            "_custom_json": {
729              "_display": []
730            },
731            "docket_number": "171180622894918164152",
732            "partial_can_ret": false,
733            "country_of_origin": "China",
734            "parent_docket_number": "171180622894918164152",
735            "product_discount_applied": {
736              "_id": "65f2c7c5352864fccbd0b7dc",
737              "job_id": "65f2c7aba17754320ad4f33c",
738              "app_ids": [
739                "614b42d1ea943427b5f46d1e"
740              ],
741              "item_id": 1182446,
742              "discount": [
743                {
744                  "value": 50,
745                  "min_items": 1
746                }
747              ],
748              "zone_ids": [],
749              "abandoned": false,
750              "brand_ids": [
751                356
752              ],
753              "company_id": 46,
754              "created_on": "2024-03-14T13:49:02.699000",
755              "modified_on": "2024-03-14T13:49:02.699000",
756              "discount_job": {
757                "_id": "65f2c7aba17754320ad4f33c",
758                "meta": {
759                  "triggerhappyEndJob": "65f3003562b57f4a495ca54f",
760                  "triggerhappyStartJob": "65f3003562b57f779c5ca54e"
761                },
762                "name": "HKM BRA PARTY FLAT 50% OFF",
763                "value": null,
764                "app_ids": [
765                  "614b42d1ea943427b5f46d1e"
766                ],
767                "job_type": "app|brand|inventory",
768                "validity": {
769                  "end": "2024-04-29T18:30:00",
770                  "start": "2024-03-14T18:50:00"
771                },
772                "zone_ids": [],
773                "brand_ids": [
774                  356
775                ],
776                "file_path": "/company/46/self/documents/product-import/free/original/KlA4KBqfk-50percent-off.xlsx",
777                "is_active": true,
778                "company_id": 46,
779                "created_by": {
780                  "user_id": "23542762",
781                  "username": "test_example_com_12345"
782                },
783                "created_on": "2024-03-14T09:47:23.981000",
784                "modified_by": {
785                  "user_id": "23542762",
786                  "username": "test_example_com_12345"
787                },
788                "modified_on": "2024-03-14T18:50:00.061000",
789                "discount_meta": {
790                  "hours": 0,
791                  "timer": false,
792                  "minutes": 0
793                },
794                "discount_type": "percentage",
795                "discount_level": "application"
796              },
797              "discount_meta": {
798                "end": "2024-04-29T18:30:00Z",
799                "start": "2024-03-14T18:50:00Z",
800                "timer": false
801              },
802              "discount_type": "percentage",
803              "seller_identifier": "000000410255725001"
804            },
805            "delivery_charges_hsn_code": "996819",
806            "multi_quantity_bag_enabled": false
807          }
808        }
809      ],
810      "bag_status_history": [
811        {
812          "id": 216743852,
813          "updated_ts": "2024-03-30T13:43:49Z",
814          "kafka_sync": false,
815          "shipment_id": "17118062289491816415",
816          "state_type": "operational",
817          "state_id": 89,
818          "updated_at": "2024-03-30T19:13:49+00:00",
819          "bag_id": 33844742,
820          "created_at": "2024-03-30T19:13:49+00:00",
821          "delivery_awb_number": null,
822          "delivery_partner_id": null,
823          "created_ts": "2024-03-30T13:43:49Z",
824          "store_id": 14406,
825          "status": "pending",
826          "bag_state_mapper": {
827            "journey_type": "forward",
828            "app_display_name": "Pending",
829            "state_type": "operational",
830            "app_state_name": "pending",
831            "name": "pending",
832            "app_facing": true,
833            "id": 89,
834            "display_name": "Pending",
835            "notify_customer": true,
836            "is_active": true
837          },
838          "reasons": [],
839          "action_user": {}
840        },
841        {
842          "id": 216743931,
843          "updated_ts": "2024-03-30T13:44:50Z",
844          "kafka_sync": false,
845          "shipment_id": "17118062289491816415",
846          "state_type": "operational",
847          "state_id": 1,
848          "updated_at": "2024-03-30T19:14:51+00:00",
849          "bag_id": 33844742,
850          "created_at": "2024-03-30T19:14:51+00:00",
851          "delivery_awb_number": null,
852          "delivery_partner_id": null,
853          "created_ts": "2024-03-30T13:44:50Z",
854          "store_id": 14406,
855          "status": "placed",
856          "bag_state_mapper": {
857            "journey_type": "forward",
858            "app_display_name": "Processing",
859            "state_type": "operational",
860            "app_state_name": "processing",
861            "name": "placed",
862            "app_facing": true,
863            "id": 1,
864            "display_name": "Placed",
865            "notify_customer": true,
866            "is_active": true
867          },
868          "reasons": [],
869          "action_user": {}
870        },
871        {
872          "id": 216808119,
873          "updated_ts": "2024-03-31T05:45:01Z",
874          "kafka_sync": false,
875          "shipment_id": "17118062289491816415",
876          "state_type": "operational",
877          "state_id": 2,
878          "updated_at": "2024-03-31T11:15:02+00:00",
879          "bag_id": 33844742,
880          "created_at": "2024-03-31T11:15:02+00:00",
881          "delivery_awb_number": null,
882          "delivery_partner_id": null,
883          "created_ts": "2024-03-31T05:45:01Z",
884          "store_id": 14406,
885          "status": "bag_confirmed",
886          "bag_state_mapper": {
887            "journey_type": "forward",
888            "app_display_name": "Confirmed",
889            "state_type": "operational",
890            "app_state_name": "confirmed",
891            "name": "bag_confirmed",
892            "app_facing": true,
893            "id": 2,
894            "display_name": "Confirmed",
895            "notify_customer": false,
896            "is_active": true
897          },
898          "reasons": [],
899          "action_user": {
900            "title": "Staff",
901            "user_id": "23546659",
902            "user_name": "65967faf620ff7c9db513d9c",
903            "order_role": "full_access",
904            "employee_code": ""
905          }
906        },
907        {
908          "id": 216808124,
909          "updated_ts": "2024-03-31T05:45:02Z",
910          "kafka_sync": false,
911          "shipment_id": "17118062289491816415",
912          "state_type": "operational",
913          "state_id": 91,
914          "updated_at": "2024-03-31T11:15:02+00:00",
915          "bag_id": 33844742,
916          "created_at": "2024-03-31T11:15:02+00:00",
917          "delivery_awb_number": null,
918          "delivery_partner_id": null,
919          "created_ts": "2024-03-31T05:45:02Z",
920          "store_id": 14406,
921          "status": "bag_invoiced",
922          "bag_state_mapper": {
923            "journey_type": "forward",
924            "app_display_name": "Bag Invoiced",
925            "state_type": "operational",
926            "app_state_name": "bag_invoiced",
927            "name": "bag_invoiced",
928            "app_facing": false,
929            "id": 91,
930            "display_name": "Bag Invoiced",
931            "notify_customer": false,
932            "is_active": true
933          },
934          "reasons": [],
935          "action_user": {}
936        },
937        {
938          "id": 216808130,
939          "updated_ts": "2024-03-31T05:45:02Z",
940          "kafka_sync": false,
941          "shipment_id": "17118062289491816415",
942          "state_type": "operational",
943          "state_id": 113,
944          "updated_at": "2024-03-31T11:15:02+00:00",
945          "bag_id": 33844742,
946          "created_at": "2024-03-31T11:15:02+00:00",
947          "delivery_awb_number": null,
948          "delivery_partner_id": null,
949          "created_ts": "2024-03-31T05:45:02Z",
950          "store_id": 14406,
951          "status": "ready_for_dp_assignment",
952          "bag_state_mapper": {
953            "journey_type": "forward",
954            "app_display_name": "Ready For Dp Assignment",
955            "state_type": "operational",
956            "app_state_name": "ready_for_dp_assignment",
957            "name": "ready_for_dp_assignment",
958            "app_facing": false,
959            "id": 113,
960            "display_name": "Ready For Dp Assignment",
961            "notify_customer": false,
962            "is_active": true
963          },
964          "reasons": [],
965          "action_user": {}
966        }
967      ],
968      "fulfilling_store": {
969        "id": 14406,
970        "code": "R578",
971        "name": "Luhari DC",
972        "address": "test address",
973        "state": "Haryana",
974        "city": "Jhajjar",
975        "pincode": "124108",
976        "country": "India",
977        "phone": "1111111111",
978        "meta": {
979          "timing": [
980            {
981              "weekday": "monday",
982              "opening": {
983                "hour": 11,
984                "minute": 0
985              },
986              "closing": {
987                "hour": 22,
988                "minute": 0
989              },
990              "open": true
991            },
992            {
993              "weekday": "tuesday",
994              "opening": {
995                "hour": 11,
996                "minute": 0
997              },
998              "closing": {
999                "hour": 22,
1000                "minute": 0
1001              },
1002              "open": true
1003            },
1004            {
1005              "weekday": "wednesday",
1006              "opening": {
1007                "hour": 11,
1008                "minute": 0
1009              },
1010              "closing": {
1011                "hour": 22,
1012                "minute": 0
1013              },
1014              "open": true
1015            },
1016            {
1017              "weekday": "thursday",
1018              "opening": {
1019                "hour": 11,
1020                "minute": 0
1021              },
1022              "closing": {
1023                "hour": 22,
1024                "minute": 0
1025              },
1026              "open": true
1027            },
1028            {
1029              "weekday": "friday",
1030              "opening": {
1031                "hour": 11,
1032                "minute": 0
1033              },
1034              "closing": {
1035                "hour": 22,
1036                "minute": 0
1037              },
1038              "open": true
1039            },
1040            {
1041              "weekday": "saturday",
1042              "opening": {
1043                "hour": 11,
1044                "minute": 0
1045              },
1046              "closing": {
1047                "hour": 22,
1048                "minute": 0
1049              },
1050              "open": true
1051            },
1052            {
1053              "weekday": "sunday",
1054              "opening": {
1055                "hour": 11,
1056                "minute": 0
1057              },
1058              "closing": {
1059                "hour": 22,
1060                "minute": 0
1061              },
1062              "open": true
1063            }
1064          ],
1065          "stage": null,
1066          "display_name": "Luhari DC",
1067          "notification_emails": [
1068            "test@example.com",
1069            "test@example.com"
1070          ],
1071          "product_return_config": {
1072            "on_same_store": true
1073          },
1074          "gst_credentials": {
1075            "e_invoice": {
1076              "enabled": false
1077            },
1078            "e_waybill": {
1079              "enabled": false
1080            }
1081          },
1082          "gst_number": "06AADCR7395F1Z4",
1083          "additional_contact_details": {
1084            "number": [
1085              "91 - 8888888888",
1086              "91 - 8888888888"
1087            ]
1088          },
1089          "documents": {
1090            "gst": {
1091              "type": "gst",
1092              "value": "06AADCR7395F1Z4",
1093              "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/46/stores/all/legal/documents/free/original/o9DgOj4Qu-GST-WH.pdf",
1094              "verified": true,
1095              "legal_name": "Reliance Brands Limited"
1096            }
1097          },
1098          "auto_invoice": true,
1099          "credit_note": true,
1100          "ewaybill_portal_details": null
1101        },
1102        "fulfillment_channel": "pulse",
1103        "location_type": "warehouse",
1104        "company_id": 46,
1105        "is_active": false,
1106        "tags": []
1107      },
1108      "prices": {
1109        "amount_paid": 2094,
1110        "refund_amount": 2094,
1111        "price_marked": 4190,
1112        "cod_charges": 0,
1113        "discount": 2096,
1114        "cashback_applied": 0,
1115        "delivery_charge": 0,
1116        "fynd_credits": 0,
1117        "cashback": 0,
1118        "price_effective": 2094,
1119        "refund_credit": 0,
1120        "value_of_good": 1911.13,
1121        "coupon_value": 0,
1122        "tax_collected_at_source": 0,
1123        "promotion_effective_discount": 0,
1124        "fynd_promotion_effective_discount": 0,
1125        "seller_promotion_effective_discount": 0,
1126        "cn_refund_amount": 0,
1127        "gift_price": 0,
1128        "amount_paid_roundoff": 2094
1129      },
1130      "payments": {
1131        "id": 8,
1132        "mode": "PP",
1133        "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
1134        "display_name": "PartnerPay",
1135        "display_priority": 7,
1136        "source": "PartnerPay",
1137        "is_active": false
1138      },
1139      "affiliate_details": {
1140        "id": "614b42d1ea943427b5f46d1e",
1141        "affiliate_bag_id": "33844742",
1142        "affiliate_order_id": "251640",
1143        "company_affiliate_tag": "HUNKEMOLLER_IN",
1144        "affiliate_id": "614b42d1ea943427b5f46d1e",
1145        "affiliate_shipment_id": "17118062289491816415",
1146        "shipment_meta": {
1147          "sla": 1711979028,
1148          "weight": 200,
1149          "external": {},
1150          "vertical": "NA",
1151          "dimension": {
1152            "width": 34.29,
1153            "height": 11,
1154            "length": 43.18
1155          },
1156          "formatted": {
1157            "max": "Sun, 07 Apr",
1158            "min": "Fri, 05 Apr"
1159          },
1160          "lock_data": {
1161            "mto": false,
1162            "locked": false,
1163            "lock_message": ""
1164          },
1165          "timestamp": {
1166            "max": 1712497428,
1167            "min": 1712324628
1168          },
1169          "bag_weight": {
1170            "33844742": 100,
1171            "33844743": 100
1172          },
1173          "debug_info": {
1174            "stormbreaker_uuid": ""
1175          },
1176          "dp_options": {
1177            "33": {
1178              "name": "dp_account|33",
1179              "type": "dp",
1180              "dp_tat": {
1181                "max": 345600,
1182                "min": 172800
1183              },
1184              "sub_type": "dp_account",
1185              "area_code": {
1186                "to_pincode": "",
1187                "from_pincode": ""
1188              },
1189              "is_active": true,
1190              "parent_id": "dp:33",
1191              "scheme_id": "65952d8eb8ac58febb890c04",
1192              "f_priority": 1,
1193              "operations": [],
1194              "qc_enabled": false,
1195              "r_priority": 1,
1196              "fm_priority": 1,
1197              "lm_priority": 1,
1198              "display_name": "Bluedart Express 0-5kg",
1199              "extension_id": "656f216f9117f06286a7c6f7",
1200              "payment_mode": "all",
1201              "rvp_priority": 1,
1202              "assign_dp_from_sb": false,
1203              "dp_shipping_charges": 200,
1204              "external_account_id": "65952d8eb8ac58febb890c04",
1205              "internal_account_id": 33
1206            }
1207          },
1208          "order_type": null,
1209          "dp_sort_key": null,
1210          "is_self_ship": false,
1211          "shipment_cost": 2094,
1212          "delivery_slots": {},
1213          "is_auto_assign": true,
1214          "packaging_name": "POLYB_L_1713P5",
1215          "courier_partners": [
1216            {
1217              "tat": {
1218                "max": 345600,
1219                "min": 172800
1220              },
1221              "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",
1222              "area_code": {
1223                "source": null,
1224                "destination": null
1225              },
1226              "scheme_id": "65952d8eb8ac58febb890c04",
1227              "display_name": "Bluedart Express 0-5kg",
1228              "extension_id": "656f216f9117f06286a7c6f7",
1229              "is_self_ship": false,
1230              "is_qc_enabled": false,
1231              "is_own_account": false
1232            },
1233            {
1234              "tat": {
1235                "max": 345600,
1236                "min": 172800
1237              },
1238              "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",
1239              "area_code": {
1240                "source": null,
1241                "destination": null
1242              },
1243              "scheme_id": "65952a7b199ac0fd9537b1a7",
1244              "display_name": "Delhivery Air 0-1kg",
1245              "extension_id": "656f1f18c24dabc79325b1ba",
1246              "is_self_ship": false,
1247              "is_qc_enabled": false,
1248              "is_own_account": false
1249            },
1250            {
1251              "tat": {
1252                "max": 345600,
1253                "min": 172800
1254              },
1255              "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",
1256              "area_code": {
1257                "source": null,
1258                "destination": null
1259              },
1260              "scheme_id": "65952bd1974836aaa9869518",
1261              "display_name": "Xpressbees Air 0-1kg",
1262              "extension_id": "656f20c89117f06286a7c6f2",
1263              "is_self_ship": false,
1264              "is_qc_enabled": false,
1265              "is_own_account": false
1266            },
1267            {
1268              "tat": {
1269                "max": 345600,
1270                "min": 172800
1271              },
1272              "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",
1273              "area_code": {
1274                "source": null,
1275                "destination": null
1276              },
1277              "scheme_id": "6595265414c31ce4b279d9c6",
1278              "display_name": "Ecomexpress Surface 0-5kg",
1279              "extension_id": "656f20b99117f06286a7c6ed",
1280              "is_self_ship": false,
1281              "is_qc_enabled": false,
1282              "is_own_account": false
1283            }
1284          ],
1285          "fulfillment_tags": [],
1286          "is_international": false,
1287          "is_export_shipment": false,
1288          "same_store_available": true,
1289          "fulfill_virtual_invoice": true,
1290          "fulfilment_priority_text": null,
1291          "store_invoice_updated_ts": "2024-03-31T05:45:02Z",
1292          "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",
1293          "E-invoice_applicable_response": {
1294            "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
1295            "is_applicable": false
1296          },
1297          "auto_trigger_dp_assignment_ACF": true,
1298          "eligible_for_split": false
1299        },
1300        "affiliate_meta": {
1301          "fynd": {
1302            "fulfilment_identifier": "pulse",
1303            "fulfilment_identifiers_list": [
1304              "pulse"
1305            ]
1306          },
1307          "channel_shipment_id": null,
1308          "channel_order_id": null,
1309          "due_date": null,
1310          "is_priority": false,
1311          "box_type": null,
1312          "coupon_code": "",
1313          "size_level_total_qty": 1,
1314          "loyalty_discount": 0,
1315          "employee_discount": 0
1316        },
1317        "affiliate_store_id": "14406",
1318        "pdf_links": {
1319          "label_type": "fynd",
1320          "invoice_type": "fynd"
1321        },
1322        "config": {
1323          "id": "614b42d1ea943427b5f46d1e",
1324          "meta": [],
1325          "name": "HUNKEMOLLER_IN",
1326          "owner": "5dcfacd2cde9054e3d667660",
1327          "token": "iDPuTkCNL",
1328          "secret": "SC7_8fh52H",
1329          "createdAt": null,
1330          "updatedAt": null,
1331          "description": "",
1332          "dp_assignment": true,
1333          "app_company_id": 46,
1334          "article_assignment": {
1335            "level": "multi-companies",
1336            "strategy": "optimal"
1337          },
1338          "force_reassignment": false,
1339          "sales_channel_logo": "/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",
1340          "order_source_domain": "hunkemoller.fynd.io",
1341          "post_order_reassignment": true
1342        }
1343      },
1344      "article_details": {
1345        "status": {
1346          "ready_for_dp_assignment": {
1347            "630de4e5ea54210bdddf2882": {
1348              "uid": "630de4e5ea54210bdddf2882",
1349              "_id": "630de4e5ea54210bdddf2882",
1350              "is_set": false,
1351              "bag_ids": [
1352                {
1353                  "bag_id": 33844742,
1354                  "quantity": 1
1355                }
1356              ],
1357              "quantity": 1,
1358              "reasons": {}
1359            },
1360            "62842a1b68812ee2b6d0b9d9": {
1361              "uid": "62842a1b68812ee2b6d0b9d9",
1362              "_id": "62842a1b68812ee2b6d0b9d9",
1363              "is_set": false,
1364              "bag_ids": [
1365                {
1366                  "bag_id": 33844743,
1367                  "quantity": 1
1368                }
1369              ],
1370              "quantity": 1,
1371              "reasons": {}
1372            }
1373          }
1374        }
1375      },
1376      "dp_details": {
1377        "id": null,
1378        "name": null,
1379        "awb_no": null,
1380        "eway_bill_id": null,
1381        "track_url": null,
1382        "gst_tag": "sgst",
1383        "extension_id": null,
1384        "scheme_id": null,
1385        "courier_partner_slug": null
1386      },
1387      "rto_address": {
1388        "store_address_json": {
1389          "version": "1.0",
1390          "contact_person": "test",
1391          "address": "",
1392          "address1": "test address",
1393          "address2": "dummy data",
1394          "name": "test",
1395          "area": "",
1396          "area_code": "",
1397          "area_code_slug": "",
1398          "landmark": "test address",
1399          "city": "Jhajjar",
1400          "state": "Haryana",
1401          "country": "India",
1402          "pincode": "124108",
1403          "longitude": 72.8423802,
1404          "sector": "",
1405          "latitude": 19.0653252,
1406          "phone": "1111111111",
1407          "email": "test@example.com",
1408          "address_type": "store",
1409          "address_category": "store",
1410          "created_at": "2024-03-31 11:15:02",
1411          "updated_at": "2024-03-31 11:15:02",
1412          "country_phone_code": null,
1413          "country_iso_code": "IN",
1414          "country_code": "IN",
1415          "display_address": "test address"
1416        },
1417        "code": "R578",
1418        "id": 14406,
1419        "location_type": "warehouse",
1420        "name": "Luhari DC",
1421        "company_id": 46,
1422        "address1": "test address",
1423        "address2": "test address",
1424        "display_address": "test address",
1425        "city": "Jhajjar",
1426        "state": "Haryana",
1427        "sector": "",
1428        "country": "India",
1429        "pincode": "124108",
1430        "store_email": "test@example.com",
1431        "contact_person": "test",
1432        "phone": "1111111111"
1433      },
1434      "weight": {
1435        "value": 200,
1436        "unit": "gram"
1437      },
1438      "shipment_meta": {
1439        "sla": 1711979028,
1440        "weight": 200,
1441        "external": {},
1442        "vertical": "NA",
1443        "dimension": {
1444          "width": 34.29,
1445          "height": 11,
1446          "length": 43.18
1447        },
1448        "formatted": {
1449          "max": "Sun, 07 Apr",
1450          "min": "Fri, 05 Apr"
1451        },
1452        "lock_data": {
1453          "mto": false,
1454          "locked": false,
1455          "lock_message": ""
1456        },
1457        "timestamp": {
1458          "max": 1712497428,
1459          "min": 1712324628
1460        },
1461        "bag_weight": {
1462          "33844742": 100,
1463          "33844743": 100
1464        },
1465        "debug_info": {
1466          "stormbreaker_uuid": ""
1467        },
1468        "dp_options": {
1469          "33": {
1470            "name": "dp_account|33",
1471            "type": "dp",
1472            "dp_tat": {
1473              "max": 345600,
1474              "min": 172800
1475            },
1476            "sub_type": "dp_account",
1477            "area_code": {
1478              "to_pincode": "",
1479              "from_pincode": ""
1480            },
1481            "is_active": true,
1482            "parent_id": "dp:33",
1483            "scheme_id": "65952d8eb8ac58febb890c04",
1484            "f_priority": 1,
1485            "operations": [],
1486            "qc_enabled": false,
1487            "r_priority": 1,
1488            "fm_priority": 1,
1489            "lm_priority": 1,
1490            "display_name": "Bluedart Express 0-5kg",
1491            "extension_id": "656f216f9117f06286a7c6f7",
1492            "payment_mode": "all",
1493            "rvp_priority": 1,
1494            "assign_dp_from_sb": false,
1495            "dp_shipping_charges": 200,
1496            "external_account_id": "65952d8eb8ac58febb890c04",
1497            "internal_account_id": 33
1498          }
1499        },
1500        "order_type": null,
1501        "dp_sort_key": null,
1502        "is_self_ship": false,
1503        "shipment_cost": 2094,
1504        "delivery_slots": {},
1505        "is_auto_assign": true,
1506        "packaging_name": "POLYB_L_1713P5",
1507        "courier_partners": [
1508          {
1509            "tat": {
1510              "max": 345600,
1511              "min": 172800
1512            },
1513            "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",
1514            "area_code": {
1515              "source": null,
1516              "destination": null
1517            },
1518            "scheme_id": "65952d8eb8ac58febb890c04",
1519            "display_name": "Bluedart Express 0-5kg",
1520            "extension_id": "656f216f9117f06286a7c6f7",
1521            "is_self_ship": false,
1522            "is_qc_enabled": false,
1523            "is_own_account": false
1524          },
1525          {
1526            "tat": {
1527              "max": 345600,
1528              "min": 172800
1529            },
1530            "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",
1531            "area_code": {
1532              "source": null,
1533              "destination": null
1534            },
1535            "scheme_id": "65952a7b199ac0fd9537b1a7",
1536            "display_name": "Delhivery Air 0-1kg",
1537            "extension_id": "656f1f18c24dabc79325b1ba",
1538            "is_self_ship": false,
1539            "is_qc_enabled": false,
1540            "is_own_account": false
1541          },
1542          {
1543            "tat": {
1544              "max": 345600,
1545              "min": 172800
1546            },
1547            "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",
1548            "area_code": {
1549              "source": null,
1550              "destination": null
1551            },
1552            "scheme_id": "65952bd1974836aaa9869518",
1553            "display_name": "Xpressbees Air 0-1kg",
1554            "extension_id": "656f20c89117f06286a7c6f2",
1555            "is_self_ship": false,
1556            "is_qc_enabled": false,
1557            "is_own_account": false
1558          },
1559          {
1560            "tat": {
1561              "max": 345600,
1562              "min": 172800
1563            },
1564            "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",
1565            "area_code": {
1566              "source": null,
1567              "destination": null
1568            },
1569            "scheme_id": "6595265414c31ce4b279d9c6",
1570            "display_name": "Ecomexpress Surface 0-5kg",
1571            "extension_id": "656f20b99117f06286a7c6ed",
1572            "is_self_ship": false,
1573            "is_qc_enabled": false,
1574            "is_own_account": false
1575          }
1576        ],
1577        "fulfillment_tags": [],
1578        "is_international": false,
1579        "is_export_shipment": false,
1580        "same_store_available": true,
1581        "fulfill_virtual_invoice": true,
1582        "fulfilment_priority_text": null,
1583        "store_invoice_updated_ts": "2024-03-31T05:45:02Z",
1584        "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",
1585        "E-invoice_applicable_response": {
1586          "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
1587          "is_applicable": false
1588        },
1589        "auto_trigger_dp_assignment_ACF": true,
1590        "eligible_for_split": false
1591      },
1592      "shipment_gst": {
1593        "value_of_good": 1911.13,
1594        "gst_fee": 182.87,
1595        "brand_calculated_amount": 2094,
1596        "tax_collected_at_source": 0,
1597        "gstin_code": "06AADCR7395F1Z4"
1598      },
1599      "store_invoice_id": "E00014406A009663",
1600      "credit_note_id": "",
1601      "order_created": "2024-03-30T19:13:49+00:00",
1602      "payment_methods": {
1603        "PP": {
1604          "amount": 2094,
1605          "mode": "PP",
1606          "name": "PartnerPay",
1607          "collect_by": "fynd",
1608          "refund_by": "fynd",
1609          "meta": {
1610            "id": "FY660817140E6E656DB9",
1611            "mode": "",
1612            "logo_url": {
1613              "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png",
1614              "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payments/original/Az7lv_ytK-netbanking.png"
1615            },
1616            "payment_id": null
1617          }
1618        }
1619      },
1620      "payment_info": [],
1621      "order": {
1622        "ordering_channel": "ECOMM",
1623        "ordering_source": "storefront",
1624        "affiliate_order_date": "2024-03-30T19:13:49+00:00",
1625        "affiliate_order_id": "251640",
1626        "fynd_order_id": "FY660817140E6E656DB9",
1627        "mode_of_payment": "ECOMM",
1628        "source": "affiliate",
1629        "total_order_value": 2094,
1630        "collect_by": "fynd",
1631        "refund_by": "fynd",
1632        "order_value": 2094,
1633        "meta": {
1634          "mode": "live",
1635          "files": [],
1636          "staff": {},
1637          "cart_id": -2,
1638          "comment": "",
1639          "currency": {
1640            "currency_code": "INR",
1641            "currency_name": "Indian Rupee",
1642            "currency_symbol": "₹",
1643            "currency_sub_unit": "Paisa"
1644          },
1645          "device_id": null,
1646          "extra_meta": {},
1647          "order_tags": [],
1648          "order_type": "HomeDelivery",
1649          "custom_cart": {},
1650          "custom_meta": [],
1651          "employee_id": null,
1652          "company_logo": "/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",
1653          "payment_type": "fynd",
1654          "mongo_cart_id": -2,
1655          "cart_object_id": "None",
1656          "order_platform": "openapi",
1657          "ordering_store": null,
1658          "seller_details": {
1659            "currency": {
1660              "code": "INR",
1661              "name": "Indian Rupee",
1662              "symbol": "Rs."
1663            },
1664            "timezone": "Asia/Kolkata",
1665            "country_code": "IN"
1666          },
1667          "conversion_rate": {
1668            "base": "INR",
1669            "rates": {
1670              "INR": {
1671                "name": "Indian Rupee",
1672                "value": 1,
1673                "symbol": "₹",
1674                "sub_unit": "Paisa"
1675              }
1676            },
1677            "timestamp": 1711756814000
1678          },
1679          "currency_symbol": "₹",
1680          "transaction_data": {
1681            "id": "FY660817140E6E656DB9",
1682            "app_id": "614b42d1ea943427b5f46d1e",
1683            "device": "desktop",
1684            "source": "desktop-fynd",
1685            "status": "complete",
1686            "headers": {
1687              "via": "1.1 google",
1688              "host": "api.fynd.com",
1689              "accept": "*/*",
1690              "x-scheme": "https",
1691              "x-fp-date": "20240330T191450Z",
1692              "x-real-ip": "34.100.227.214",
1693              "user-agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",
1694              "x-skip-cors": "true",
1695              "x-user-data": "{\"debug\":{\"source\":\"grimlock\",\"platform\":\"000000000000000000000001\"},\"username\":\"pritam_a7x_gmail_com_50522_23071964\",\"updated_at\":\"2024-02-12T03:24:17.694Z\",\"firstName\":\"test\",\"created_at\":\"2019-04-26T07:02:56.187Z\",\"lastName\":\"Ghosh\",\"_id\":\"5cd40115c01aac9daf2d048f\",\"phoneNumbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"updatedAt\":\"2024-02-12T03:24:17.694Z\",\"password_last_modified\":\"2024-02-12T03:24:17.688Z\",\"password_history\":[],\"profilePicUrl\":\"http:\\/\\/graph.facebook.com\\/123344\\/picture\\/?width=600&height=600\",\"phone_numbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"emails\":[{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":true},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false}],\"last_name\":\"test\",\"first_name\":\"test\",\"gender\":\"male\",\"accountType\":\"user\",\"account_type\":\"user\",\"active\":true,\"profile_pic_url\":\"http:\\/\\/graph.facebook.com\\/111111\\/picture\\/?width=600&height=600\",\"createdAt\":\"2019-04-26T07:02:56.187Z\",\"status\":\"active\",\"__v\":5,\"uid\":\"23071964\"}",
1696              "content-type": "application/json",
1697              "x-request-id": "340fcb8e8ed34eba58f71b80892afafa",
1698              "authorization": "Bearer oa-1231231231313",
1699              "uber-trace-id": "43355fab23fedd7f:135397327c24f397:43355fab23fedd7f:1",
1700              "x-super-admin": "true",
1701              "content-length": "236",
1702              "x-fp-signature": "v1.1:123124124",
1703              "accept-encoding": "deflate, gzip, br",
1704              "x-forwarded-for": "34.100.227.214",
1705              "x-fynd-trace-id": "340fcb8e8ed34eba58f71b80892afafa",
1706              "x-forwarded-host": "api.fynd.com",
1707              "x-forwarded-port": "80",
1708              "x-seller-details": "{\"country_code\":\"IN\",\"currency\":{\"code\":\"INR\",\"symbol\":\"Rs.\",\"name\":\"Indian Rupee\"},\"timezone\":\"Asia/Kolkata\"}",
1709              "x-forwarded-proto": "https",
1710              "x-forwarded-scheme": "https",
1711              "x-cloud-trace-context": "a907e8735c74b4db6ca0ef15305a1f0e/12294800319076248065",
1712              "x-original-forwarded-for": "34.100.227.214,34.120.64.114",
1713              "x-super-admin-permission": "{\"access\":{\"all\":false,\"company\":[42,46,37,1244,870,25,2250,1486,52,1567,341,442,869,334,34,2411,718,1137,517,2467,1098,2853,568,1913,2374,2,6,21,320,1607,3089,269,3576,2212,2256,43,3075,2913,4118,1951,884,1354,1582,1568,770,1069,2566,1733,2201,1291,644,1588,2274,1077,2109,822,1572,1301,3557,615,1076,2704,20,1584,3932,1943,791,2242,2195,3866,840,3751,326,1849,1079,1103,1622,1814,3138,77,1875,1841,2930,2831,49,36,520,2196,1653,1678,3006,2270,2286,2108,2922,2150,1130,3670,1121,2486,3582,1613,3767,3573,3817,105,3952,1972,2989,163,2175,3647,4003,1253,1651,61,1328,3333,1211,4211,3969,1329,4169,516,3587,4182,292,739,2326,3887,3691,1803,342,1526,3405,1305,1101,1420,3619,59,1927,726,1202,4770]},\"partner_access\":{\"all\":false,\"organization\":[]},\"_id\":\"643926b1933c6ba75040f81d\",\"user\":\"5cd40115c01aac9daf2d048f\",\"title\":\"Super Admin\",\"type\":\"user\",\"permissions\":[\"company\",\"order\"],\"roles\":[\"custom\"],\"createdAt\":\"2023-04-14T10:10:57.621Z\",\"updatedAt\":\"2023-06-23T12:38:44.534Z\",\"__v\":16,\"updated_at\":\"2024-02-15T08:43:28.321Z\"}"
1714            },
1715            "offline": true,
1716            "profile": "fynd",
1717            "currency": "INR",
1718            "merchant": {
1719              "id": 321,
1720              "meta": {
1721                "auto_refund": true
1722              },
1723              "delivery_config": {
1724                "cod": {
1725                  "refund_by": "fynd",
1726                  "collect_by": "fynd"
1727                }
1728              }
1729            },
1730            "order_id": "FY660817140E6E656DB9",
1731            "client_ip": "",
1732            "company_id": "46",
1733            "is_webview": false,
1734            "app_version": null,
1735            "merchant_id": 321,
1736            "payment_meta": {
1737              "order_id": "order_NsaTqdy0WRRHeZ",
1738              "payment_id": "pay_NsaUP8baXTb9yx",
1739              "current_status": "captured",
1740              "payment_gateway": "Razorpay"
1741            },
1742            "origin_app_id": "614b42d1ea943427b5f46d1e",
1743            "source_domain": null,
1744            "is_app_request": false,
1745            "is_ios_request": false,
1746            "is_legacy_flow": false,
1747            "aggregator_name": "Openapi",
1748            "payment_methods": [
1749              {
1750                "meta": {
1751                  "order_id": "order_NsaTqdy0WRRHeZ",
1752                  "payment_id": "pay_NsaUP8baXTb9yx",
1753                  "current_status": "captured",
1754                  "payment_gateway": "Razorpay"
1755                },
1756                "mode": "PP",
1757                "name": "prepaid",
1758                "amount": 209400
1759              }
1760            ],
1761            "x-currency-code": "",
1762            "platform_request": "fynd",
1763            "x-seller-details": {
1764              "currency": {
1765                "code": "INR",
1766                "name": "Indian Rupee",
1767                "symbol": "Rs."
1768              },
1769              "timezone": "Asia/Kolkata",
1770              "country_code": "IN"
1771            },
1772            "is_anonymous_user": false,
1773            "x-location-detail": {},
1774            "is_android_request": false,
1775            "merchant_profile_id": 964,
1776            "merchant_aggregator_id": 24,
1777            "merchant_payment_config": {
1778              "offline": {
1779                "cod": {
1780                  "pos": {
1781                    "name": "Cash on Delivery (COD)",
1782                    "is_active": true,
1783                    "cod_charges": 0,
1784                    "anonymous_cod": false,
1785                    "user_cod_limit": 0,
1786                    "cod_max_order_value": 49000,
1787                    "cod_min_order_value": 0,
1788                    "cod_charges_max_value": 49000,
1789                    "cod_charges_min_value": 0
1790                  },
1791                  "storefront": {
1792                    "name": "Cash on Delivery (COD)",
1793                    "is_active": true,
1794                    "cod_charges": 0,
1795                    "anonymous_cod": false,
1796                    "user_cod_limit": 0,
1797                    "cod_max_order_value": 49000,
1798                    "cod_min_order_value": 0,
1799                    "cod_charges_max_value": 49000,
1800                    "cod_charges_min_value": 0
1801                  }
1802                },
1803                "is_active": true
1804              }
1805            },
1806            "merchant_profile_payment_config": {
1807              "offline": {
1808                "cod": {
1809                  "is_active": true
1810                }
1811              }
1812            }
1813          },
1814          "sales_channel_logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/46/applications/614b42d1ea943427b5f46d1e/application/pictures/free-logo/original/LpwOk-7Lf-HUNKEMOLLER_IN.png",
1815          "usable_credit_notes": [],
1816          "order_child_entities": [
1817            "bag",
1818            "shipment"
1819          ],
1820          "billing_staff_details": {
1821            "id": null,
1822            "user": null,
1823            "last_name": null,
1824            "first_name": null,
1825            "employee_code": null
1826          },
1827          "platform_user_details": {
1828            "platform_user_id": null,
1829            "platform_user_last_name": "",
1830            "platform_user_first_name": "",
1831            "platform_user_employee_code": null
1832          }
1833        }
1834      },
1835      "order_source": "affiliate",
1836      "journey_type": "forward",
1837      "einvoice_info": {},
1838      "lock_status": false,
1839      "original_bag_list": [
1840        33844742,
1841        33844743
1842      ],
1843      "shipment_update_time": 1711863902.3125546,
1844      "transaction_meta": {
1845        "id": "FY660817140E6E656DB9",
1846        "app_id": "614b42d1ea943427b5f46d1e",
1847        "device": "desktop",
1848        "source": "desktop-fynd",
1849        "status": "complete",
1850        "headers": {
1851          "via": "1.1 google",
1852          "host": "api.fynd.com",
1853          "accept": "*/*",
1854          "x-scheme": "https",
1855          "x-fp-date": "20240330T191450Z",
1856          "x-real-ip": "34.100.227.214",
1857          "user-agent": "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.13 (KHTML, like Gecko) Chrome/0.A.B.C Safari/525.13",
1858          "x-skip-cors": "true",
1859          "x-user-data": "{\"debug\":{\"source\":\"grimlock\",\"platform\":\"000000000000000000000001\"},\"username\":\"pritam_a7x_gmail_com_50522_23071964\",\"updated_at\":\"2024-02-12T03:24:17.694Z\",\"firstName\":\"test\",\"created_at\":\"2019-04-26T07:02:56.187Z\",\"lastName\":\"test\",\"_id\":\"5cd40115c01aac9daf2d048f\",\"phoneNumbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"updatedAt\":\"2024-02-12T03:24:17.694Z\",\"password_last_modified\":\"2024-02-12T03:24:17.688Z\",\"password_history\":[],\"profilePicUrl\":\"http:\\/\\/graph.facebook.com\\/123123\\/picture\\/?width=600&height=600\",\"phone_numbers\":[{\"active\":true,\"country_code\":91,\"phone\":\"1111111111\",\"verified\":true,\"countryCode\":91,\"primary\":true}],\"emails\":[{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":true},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false},{\"active\":true,\"verified\":true,\"email\":\"test@example.com\",\"primary\":false}],\"last_name\":\"test\",\"first_name\":\"test\",\"gender\":\"male\",\"accountType\":\"user\",\"account_type\":\"user\",\"active\":true,\"profile_pic_url\":\"http:\\/\\/graph.facebook.com\\/11111\\/picture\\/?width=600&height=600\",\"createdAt\":\"2019-04-26T07:02:56.187Z\",\"status\":\"active\",\"__v\":5,\"uid\":\"23071964\"}",
1860          "content-type": "application/json",
1861          "x-request-id": "340fcb8e8ed34eba58f71b80892afafa",
1862          "authorization": "Bearer oa-1112133123",
1863          "uber-trace-id": "43355fab23fedd7f:135397327c24f397:43355fab23fedd7f:1",
1864          "x-super-admin": "true",
1865          "content-length": "236",
1866          "x-fp-signature": "v1.1:12312312313",
1867          "accept-encoding": "deflate, gzip, br",
1868          "x-forwarded-for": "34.100.227.214",
1869          "x-fynd-trace-id": "340fcb8e8ed34eba58f71b80892afafa",
1870          "x-forwarded-host": "api.fynd.com",
1871          "x-forwarded-port": "80",
1872          "x-seller-details": "{\"country_code\":\"IN\",\"currency\":{\"code\":\"INR\",\"symbol\":\"Rs.\",\"name\":\"Indian Rupee\"},\"timezone\":\"Asia/Kolkata\"}",
1873          "x-forwarded-proto": "https",
1874          "x-forwarded-scheme": "https",
1875          "x-cloud-trace-context": "a907e8735c74b4db6ca0ef15305a1f0e/12294800319076248065",
1876          "x-original-forwarded-for": "34.100.227.214,34.120.64.114",
1877          "x-super-admin-permission": "{\"access\":{\"all\":false,\"company\":[42,46,37,1244,870,25,2250,1486,52,1567,341,442,869,334,34,2411,718,1137,517,2467,1098,2853,568,1913,2374,2,6,21,320,1607,3089,269,3576,2212,2256,43,3075,2913,4118,1951,884,1354,1582,1568,770,1069,2566,1733,2201,1291,644,1588,2274,1077,2109,822,1572,1301,3557,615,1076,2704,20,1584,3932,1943,791,2242,2195,3866,840,3751,326,1849,1079,1103,1622,1814,3138,77,1875,1841,2930,2831,49,36,520,2196,1653,1678,3006,2270,2286,2108,2922,2150,1130,3670,1121,2486,3582,1613,3767,3573,3817,105,3952,1972,2989,163,2175,3647,4003,1253,1651,61,1328,3333,1211,4211,3969,1329,4169,516,3587,4182,292,739,2326,3887,3691,1803,342,1526,3405,1305,1101,1420,3619,59,1927,726,1202,4770]},\"partner_access\":{\"all\":false,\"organization\":[]},\"_id\":\"643926b1933c6ba75040f81d\",\"user\":\"5cd40115c01aac9daf2d048f\",\"title\":\"Super Admin\",\"type\":\"user\",\"permissions\":[\"company\",\"order\"],\"roles\":[\"custom\"],\"createdAt\":\"2023-04-14T10:10:57.621Z\",\"updatedAt\":\"2023-06-23T12:38:44.534Z\",\"__v\":16,\"updated_at\":\"2024-02-15T08:43:28.321Z\"}"
1878        },
1879        "offline": true,
1880        "profile": "fynd",
1881        "currency": "INR",
1882        "merchant": {
1883          "id": 321,
1884          "meta": {
1885            "auto_refund": true
1886          },
1887          "delivery_config": {
1888            "cod": {
1889              "refund_by": "fynd",
1890              "collect_by": "fynd"
1891            }
1892          }
1893        },
1894        "order_id": "FY660817140E6E656DB9",
1895        "client_ip": "",
1896        "company_id": "46",
1897        "is_webview": false,
1898        "app_version": null,
1899        "merchant_id": 321,
1900        "payment_meta": {
1901          "order_id": "order_NsaTqdy0WRRHeZ",
1902          "payment_id": "pay_NsaUP8baXTb9yx",
1903          "current_status": "captured",
1904          "payment_gateway": "Razorpay"
1905        },
1906        "origin_app_id": "614b42d1ea943427b5f46d1e",
1907        "source_domain": null,
1908        "is_app_request": false,
1909        "is_ios_request": false,
1910        "is_legacy_flow": false,
1911        "aggregator_name": "Openapi",
1912        "payment_methods": [
1913          {
1914            "meta": {
1915              "order_id": "order_NsaTqdy0WRRHeZ",
1916              "payment_id": "pay_NsaUP8baXTb9yx",
1917              "current_status": "captured",
1918              "payment_gateway": "Razorpay"
1919            },
1920            "mode": "PP",
1921            "name": "prepaid",
1922            "amount": 209400
1923          }
1924        ],
1925        "x-currency-code": "",
1926        "platform_request": "fynd",
1927        "x-seller-details": {
1928          "currency": {
1929            "code": "INR",
1930            "name": "Indian Rupee",
1931            "symbol": "Rs."
1932          },
1933          "timezone": "Asia/Kolkata",
1934          "country_code": "IN"
1935        },
1936        "is_anonymous_user": false,
1937        "x-location-detail": {},
1938        "is_android_request": false,
1939        "merchant_profile_id": 964,
1940        "merchant_aggregator_id": 24,
1941        "merchant_payment_config": {
1942          "offline": {
1943            "cod": {
1944              "pos": {
1945                "name": "Cash on Delivery (COD)",
1946                "is_active": true,
1947                "cod_charges": 0,
1948                "anonymous_cod": false,
1949                "user_cod_limit": 0,
1950                "cod_max_order_value": 49000,
1951                "cod_min_order_value": 0,
1952                "cod_charges_max_value": 49000,
1953                "cod_charges_min_value": 0
1954              },
1955              "storefront": {
1956                "name": "Cash on Delivery (COD)",
1957                "is_active": true,
1958                "cod_charges": 0,
1959                "anonymous_cod": false,
1960                "user_cod_limit": 0,
1961                "cod_max_order_value": 49000,
1962                "cod_min_order_value": 0,
1963                "cod_charges_max_value": 49000,
1964                "cod_charges_min_value": 0
1965              }
1966            },
1967            "is_active": true
1968          }
1969        },
1970        "merchant_profile_payment_config": {
1971          "offline": {
1972            "cod": {
1973              "is_active": true
1974            }
1975          }
1976        }
1977      },
1978      "meta": {
1979        "sla": 1711979028,
1980        "weight": 200,
1981        "external": {},
1982        "vertical": "NA",
1983        "dimension": {
1984          "width": 34.29,
1985          "height": 11,
1986          "length": 43.18
1987        },
1988        "formatted": {
1989          "max": "Sun, 07 Apr",
1990          "min": "Fri, 05 Apr"
1991        },
1992        "lock_data": {
1993          "mto": false,
1994          "locked": false,
1995          "lock_message": ""
1996        },
1997        "timestamp": {
1998          "max": 1712497428,
1999          "min": 1712324628
2000        },
2001        "bag_weight": {
2002          "33844742": 100,
2003          "33844743": 100
2004        },
2005        "debug_info": {
2006          "stormbreaker_uuid": ""
2007        },
2008        "dp_options": {
2009          "33": {
2010            "name": "dp_account|33",
2011            "type": "dp",
2012            "dp_tat": {
2013              "max": 345600,
2014              "min": 172800
2015            },
2016            "sub_type": "dp_account",
2017            "area_code": {
2018              "to_pincode": "",
2019              "from_pincode": ""
2020            },
2021            "is_active": true,
2022            "parent_id": "dp:33",
2023            "scheme_id": "65952d8eb8ac58febb890c04",
2024            "f_priority": 1,
2025            "operations": [],
2026            "qc_enabled": false,
2027            "r_priority": 1,
2028            "fm_priority": 1,
2029            "lm_priority": 1,
2030            "display_name": "Bluedart Express 0-5kg",
2031            "extension_id": "656f216f9117f06286a7c6f7",
2032            "payment_mode": "all",
2033            "rvp_priority": 1,
2034            "assign_dp_from_sb": false,
2035            "dp_shipping_charges": 200,
2036            "external_account_id": "65952d8eb8ac58febb890c04",
2037            "internal_account_id": 33
2038          }
2039        },
2040        "order_type": null,
2041        "dp_sort_key": null,
2042        "is_self_ship": false,
2043        "shipment_cost": 2094,
2044        "delivery_slots": {},
2045        "is_auto_assign": true,
2046        "packaging_name": "POLYB_L_1713P5",
2047        "courier_partners": [
2048          {
2049            "tat": {
2050              "max": 345600,
2051              "min": 172800
2052            },
2053            "slug": "656f216f9117f06286a7c6f7|65952d8eb8ac58febb890c04",
2054            "area_code": {
2055              "source": null,
2056              "destination": null
2057            },
2058            "scheme_id": "65952d8eb8ac58febb890c04",
2059            "display_name": "Bluedart Express 0-5kg",
2060            "extension_id": "656f216f9117f06286a7c6f7",
2061            "is_self_ship": false,
2062            "is_qc_enabled": false,
2063            "is_own_account": false
2064          },
2065          {
2066            "tat": {
2067              "max": 345600,
2068              "min": 172800
2069            },
2070            "slug": "656f1f18c24dabc79325b1ba|65952a7b199ac0fd9537b1a7",
2071            "area_code": {
2072              "source": null,
2073              "destination": null
2074            },
2075            "scheme_id": "65952a7b199ac0fd9537b1a7",
2076            "display_name": "Delhivery Air 0-1kg",
2077            "extension_id": "656f1f18c24dabc79325b1ba",
2078            "is_self_ship": false,
2079            "is_qc_enabled": false,
2080            "is_own_account": false
2081          },
2082          {
2083            "tat": {
2084              "max": 345600,
2085              "min": 172800
2086            },
2087            "slug": "656f20c89117f06286a7c6f2|65952bd1974836aaa9869518",
2088            "area_code": {
2089              "source": null,
2090              "destination": null
2091            },
2092            "scheme_id": "65952bd1974836aaa9869518",
2093            "display_name": "Xpressbees Air 0-1kg",
2094            "extension_id": "656f20c89117f06286a7c6f2",
2095            "is_self_ship": false,
2096            "is_qc_enabled": false,
2097            "is_own_account": false
2098          },
2099          {
2100            "tat": {
2101              "max": 345600,
2102              "min": 172800
2103            },
2104            "slug": "656f20b99117f06286a7c6ed|6595265414c31ce4b279d9c6",
2105            "area_code": {
2106              "source": null,
2107              "destination": null
2108            },
2109            "scheme_id": "6595265414c31ce4b279d9c6",
2110            "display_name": "Ecomexpress Surface 0-5kg",
2111            "extension_id": "656f20b99117f06286a7c6ed",
2112            "is_self_ship": false,
2113            "is_qc_enabled": false,
2114            "is_own_account": false
2115          }
2116        ],
2117        "fulfillment_tags": [],
2118        "is_international": false,
2119        "is_export_shipment": false,
2120        "same_store_available": true,
2121        "fulfill_virtual_invoice": true,
2122        "fulfilment_priority_text": null,
2123        "store_invoice_updated_ts": "2024-03-31T05:45:02Z",
2124        "store_invoice_updated_date": "2024-03-31T11:15:02+00:00",
2125        "E-invoice_applicable_response": {
2126          "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
2127          "is_applicable": false
2128        },
2129        "auto_trigger_dp_assignment_ACF": true,
2130        "eligible_for_split": false
2131      },
2132      "previous_shipment_id": null,
2133      "fyndstore_emp": {},
2134      "ordering_store": {},
2135      "coupon": {},
2136      "cart_info": {
2137        "cart_id": "None",
2138        "cart_uid": -2
2139      }
2140    }
2141  }
2142}

application/shipment/update/v1

this event is triggered when shipment 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
shipment
object
Required
Properties
status
string
Required
Webhook shipment status, i.e., either create or update
shipment_status
object
Required
Status of the shipment indicating its current stage
Properties
created_at
string
Required
Shipment status created timestamp
created_ts
string
Required
Shipment status created timestamp
id
number
Required
Unique identifier associated with the shipment's status object
updated_ts
string
Required
Shipment status updated timestamp
bag_list
array of string
Required
List of Bag ids transitioned in this shipment's status
shipment_id
string
Required
Unique shipment no. that is auto-generated
status
string
Required
Shipment's operational status
current_shipment_status
string
Required
Current shipment's status; it can be financial, logistics or operational
status_created_at
string
Required
application_id
string
Required
ID of the sales channel to which the shipment belongs
shipment_id
string
Required
Unique shipment no. that is auto-generated
company_id
number
Required
ID of the company fulfilling the shipment
app_company_id
number|null|string
Required
ID of the company from which order was placed
order_id
string
Required
Unique ID of order in which the shipment is present
merchant_id
string
Required
Unique merchant id
user
object
Required
Purchaser's details such as name, last name, mobile no. and email
Properties
email
string|null
Email address of the purchaser user
id
number|null
Unique identifier for the purchaser user within the system
gender
null|string
Gender of the purchaser user (e.g., male, female, other)
first_name
string
First name of the purchaser user
external_customer_id
string|null
External identifier associated with the purchaser user in another system
mobile
string|null
Mobile phone number of the purchaser user
last_name
string
Last name of the purchaser user
mongo_user_id
string|null
User's object ID in mongodb collection
user_oid
string|null
User Object ID assigned within the system
country_phone_code
string|null
Country phone code associated with the purchaser user's mobile number
is_anonymous_user
boolean
Flag indicating whether the user is anonymous
delivery_address
object
Required
Address where the shipment is to be delivered
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the recipient's name or the organization name associated with the address
email
string
Email of the recipient associated with the delivery address
phone
string
Mobile phone number of recipient associated with the delivery address
state
string
A string indicating the state or province of the delivery address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
user_id
number|null
Unique identifier for the fulfilling user within the system
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the recipient associated with the delivery address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the delivery address was created
first_name
string
First name of the recipient associated with the delivery address
updated_at
string
| date-time
Date and time when the delivery address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the delivery address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the delivery address
display_address
string
Formatted display version of the delivery address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
billing_address
object
Required
Address by which the invoice is created
Properties
area
string
A string specifying the locality or area associated with the address
city
string
A string denoting the city or municipality of the address
name
string
A string representing the billing user's name or the organization name associated with the address
email
string
Email address associated with the billing address user
phone
string
Phone number associated with the billing address user
state
string
A string indicating the state or province of the billing address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
version
string
Address version, to be deprecated
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
latitude
number|string
The latitude of the address
area_code
string
Area code of the address
last_name
string
Last name of the individual associated with the billing address
longitude
number|string
The longitude of the address
created_at
string
| date-time
Date and time when the billing address was created
first_name
string
First name of the individual associated with the billing address
updated_at
string
| date-time
Date and time when the billing address was last updated
address_type
string
Type of address (e.g., home, office, registered)
geo_location
object
Geographic coordinates (latitude and longitude) of the billing address
Properties
latitude
number|string
The latitude of the geolocation
longitude
number|string
The longitude of the geolocation
area_code_slug
string
Unique identifier or slug for the area code associated with the address
contact_person
string
Name of the contact person associated with the billing address
display_address
string
Formatted display version of the billing address
address_category
string
Category or classification of the delivery address
country_iso_code
string
ISO code representing the country of the delivery address
country_phone_code
string|null
Phone code for the country of the delivery address
delivery_partner_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
bags
array of object
Required
Details of all the products/articles in a shipment
Array of Properties
financial_breakup
array of object
Required
Financial breakup of an item
Array of Properties
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
discount
number
Required
The total amount discounted from the original MRP/actual price
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
identifiers
object
Required
Product identifiers
Properties
sku_code
string
SKU code of the product
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
total_units
number
Required
Total number of units of the item
value_of_good
number
Required
Effective selling price - Product GST Amount
item_name
string
Required
The name of the item being referenced
size
string
Required
The physical dimensions or specifications of the item, indicating its size or measurements
entity_type
string
Required
item
object
Required
Item details
Properties
l3_category_name
string
The name of the level 3 category to which the item belongs
l1_category_id
number
ID representing the level 2 category classification of the item
code
string
A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes
branch_url
null|string
Branch URL
l2_category
array of string
l3_category
number
ID representing the level 3 category classification of the item
last_updated_at
string
| date-time
Timestamp when the item was last updated
id
number
ID of the item that is being referred
name
string
The name of the item being referenced
can_return
boolean
Flag indicating if the item is eligible for return
webstore_product_url
null|string
Product URL
gender
null|string
Gender associated with an item
l2_category_id
number
ID representing the level 2 category classification of the item
color
null|string
Color associated with and item
slug_key
string
Automatically generated unique slug of the item
can_cancel
boolean
Flag indicating if the item is eligible for cancellation
attributes
object
An object containing descriptive properties of the item
Properties
name
string
The name or title of the item
color
string
The color description of the item
essential
string
Indicates whether the item is considered essential
brand_name
string
The brand name of the item
primary_color
string
The primary color of the item
primary_color_hex
string
The hexadecimal code representing the primary color
primary-colour-hex-code
string
The hexadecimal code representing the primary color
media
array of object
An array containing media files associated with the item
brand_id
number
The unique identifier associated with the brand of the item
brand
string
The brand or manufacturer of the item
l1_category
array of string
department_id
number
The unique identifier representing the department or category to which the item belongs
size
string
The size or dimensions of the item
image
array of string
brand
object
Required
Brand's information
Properties
credit_note_allowed
boolean
Required
If a credit note ID needs to be generated by the system
created_on
string
Required
Date and time when the brand was registered or created
id
number
Required
Unique identifier assigned to the brand for reference and identification
logo
string
Required
Visual representation or emblem associated with the brand
modified_on
string
Required
Date and time of the most recent update or modification to the brand's information
is_virtual_invoice
boolean
Required
If invoice ID needs to be generated by the system
brand_name
string
Required
Name or title of the brand used for identification and representation
bag_id
number
Required
article
object
Required
Details of the article
Properties
identifiers
object
Required
Product identifiers
Properties
sku_code
string
esp_modified
string|boolean
Required
Flag representing if effective selling price has been modified
size
string
Required
The physical dimensions or specifications of the article, indicating its size or measurements
code
string
Required
A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes
set
object
Required
Details of the set article containing size distribution
Properties
quantity
integer
Number of units present
size_distribution
object
Object indicating the distribution of size and quantity of a set article
Properties
sizes
array of object
Array indicating size wise units present in a set article
Array of Properties
pieces
integer
Number of units of a particular size
size
string
Size of the article
is_set
string|boolean
Required
A boolean indicating whether the article is a set
seller_identifier
string
Required
Seller's identifier of the article
return_config
object
Required
Return configuration details of the article
Properties
time
number
Required
Number indicating number of hours or days
unit
string
Required
String indicating the unit of the time, eg. days, hours
returnable
boolean
Required
Flag indicating whether product is returnable or not
_id
string
Required
DB generated ID of the article
uid
string
Required
UID of the article
child_details
object|array
Required
Child article details if any
dimensions
object
Required
The dimension object of the article/item
Properties
height
number|null
The height of the product
width
number|null
The width of the product
is_default
boolean|null
Whether the dimension is the default one or not
unit
string|null
The unit of dimension
length
number|null
The length of the product
weight
object
Required
Object containing weight details of item/article
Properties
unit
string
The unit of weight
shipping
number
The shipping weight of the product
is_default
boolean
Whether the weight is the default one or not
currency
object
Required
Order currency details
Properties
code
string
Currency code
rate
number
The conversion rate value
expiration_date
Undefined Type
Required
current_operational_status
object
Required
Properties
created_at
string
| date-time
Required
Date and time when the shipment status record was created
created_ts
string
Required
Timestamp indicating the exact time when the shipment status record was created
id
number
Required
Unique identifier for the shipment status record
kafka_sync
boolean
Required
Flag indicating whether the shipment status update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the shipment status record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the shipment status record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
ID of the fulfilling store of the shipment
status
string
Required
Current operational status of the shipment
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Details of the user who initiated the change in the shipment's status
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
affiliate_bag_details
object
Required
Object containing external bag details like external order id, external bag id
Properties
affiliate_bag_id
string
Required
External bag id
affiliate_order_id
string
Required
External order id
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
quantity
number
Required
Total quantity of the article present in the bag.
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
price_effective
number
Required
MRP - Initial Seller provided discount
discount
number
Required
The total amount discounted from the original MRP/actual price
amount_paid
number
Required
Amount paid by the customer
coupon_effective_discount
number
Required
Coupon provided by brand or seller
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cod_charges
number
Required
The fee associated with the COD order
refund_credit
number
Required
Refund credits provided to the customer
cashback
number
Required
Cashback points
refund_amount
number
Required
Amount to be refunded on cancellation and return
added_to_fynd_cash
boolean
Required
Flag indicating whether fynd cash has been used
cashback_applied
number
Required
Cashback applied on the order
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
value_of_good
number
Required
Effective selling price - Product GST Amount
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
transfer_price
number
Required
article
brand_calculated_amount
number
Required
Price Effective - Coupon Discount (Seller) - Promotion (Seller)
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
tcs_percentage
number
Required
The percentage rate of Tax Collected at Source (TCS) applied to a transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
gift_price
number
Required
Gift card amount used
coupon_value
number
Required
Stores the coupon value as shown in the cart
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
amount_paid_roundoff
number
Required
Amount paid rounded off
order_created
string
Required
Order creation timestamp
gst_details
object
Required
GST details associated with the bag
Properties
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
gst_tag
string|null
Required
Type of GST applied - IGST, CGST, SGST
hsn_code
string|null
Required
The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_tax_percentage
number
Required
The percentage rate of GST applied to a product or service
is_default_hsn_code
boolean
Required
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
hsn_code_id
string|null
Required
The unique identifier associated with HSN code
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
igst_tax_percentage
number
Required
Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions
sgst_tax_percentage
number
Required
Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state
cgst_tax_percentage
number
Required
Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state
igst_gst_fee
string|number
Required
Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions
cgst_gst_fee
string
Required
Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state
sgst_gst_fee
string
Required
Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state
line_number
number
Required
Unique identifier associated with each bag in a shipment
applied_promos
array of object
Required
Details of the applied promotions
Array of Properties
promo_id
string
Promotion id
buy_rules
array of object
Buy rules for promotions
Array of Properties
item_criteria
object
Item criteria of promotion
cart_conditions
object
Cart conditions details for promotion
offer_text
string
Offer text of current promotion
promotion_group
string
Promotion group for the promotion
mrp_promotion
boolean
If applied promotion is applied on product MRP or ESP
promotion_name
string
Promotion name of current promotion
amount
number
Per unit discount amount applied with current promotion
discount_rules
array of object
Discount rules for promotions
Array of Properties
matched_buy_rules
array of string
Matched buy rules for promotion
raw_offer
object
raw offer details for promotion
offer
object
offer for promotion
item_criteria
object
Item criteria of promotion
ownership
object
Ownership of promotion
Properties
payable_category
string
promo amount payable category
payable_by
string
promo amount bearable party
article_quantity
integer
Quantity of article on which promotion is applicable
applied_free_articles
array of object
Applied free article for free gift item promotions
Array of Properties
free_gift_item_details
object
Free gift items details
Properties
item_slug
string
item slug
item_name
string
Item name
item_price_details
object
item price details
item_brand_name
string
item brand name
item_id
integer
Item id
item_images_url
array of string
item images URL
parent_item_identifier
string
Parent item identifier for free article
quantity
integer
Free article quantity
article_id
string
free article id
promotion_type
string
Promotion type of current promotion
meta
object
Meta object for extra data
code
string|null
Promotion code
bag_status_history
array of object
Required
Records the changes in status for a bag, providing a timeline of events and transitions
Array of Properties
created_at
string
| date-time
Required
Date and time when the bag status history record was created.
created_ts
string
Required
Timestamp indicating the exact time when the bag status history record was created
id
number
Required
Unique identifier for the bag status history record
kafka_sync
boolean
Required
Flag indicating whether the bag status history update has been sync with Kafka
updated_ts
string
Required
Timestamp indicating the last time the bag status history record was updated
updated_at
string
| date-time
Required
Date and time of the most recent update to the bag status history record
delivery_partner_id
integer|null
Required
Unique identifier of delivery partner
shipment_id
string
Required
Unique shipment no. that is auto-generated
store_id
number
Required
Store id associated with the bag
status
string
Required
Webhook shipment status, i.e., either create or update
bag_id
number
Required
The unique identifier associated with the bag
state_id
number
Required
The unique identifier associated with the state
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
delivery_awb_number
string|null
Required
Airway Bill (AWB) number associated with the delivery
bag_state_mapper
object
Required
Object representing properties of the state
Properties
journey_type
string|null
Required
Journey type can be forward or return
Enum
app_display_name
string
Required
The display name of a shipment status as it appears on the sale channel's website
state_type
string
Required
Type of the state - operational, logistics, financial
Enum
app_state_name
string
Required
The slug of a shipment status from the sale channel's front
name
string
Required
The slug of a shipment status from the platform's front
app_facing
boolean
Required
A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website
id
number
Required
The unique identifier associated with the state
display_name
string
Required
The display name of a shipment status as it appears on the platform
is_active
boolean
Required
A boolean flag indicating whether a state is active or not
reasons
array of object
Required
Reasons associated with the current shipment's status
Array of Properties
slug
string
System generated slug
display_name
string
Text that is displayed on the application front
id
integer
System generated ID of the reason object
state
integer|string
State associated with the reason
text
string
Reason text
quantity
integer
No of quantity that is being cancelled
inventory_flag
boolean
Inventory depletion action to be taken or not
action_user
object
Required
Properties
title
string
The title of the user eg. Staff, Admin
user_id
string
System generated ID associated with the user
user_name
string
System generated username associated with the user
order_role
string
Order role associated with the user eg. company_operation, store_manager
employee_code
string
Employee code associated with the user
fulfilling_store
object
Required
Details of the store responsible for fulfilling the order
Properties
id
number
Required
Unique identifier for the store.
code
string
Required
Alphanumeric code representing the store.
name
string
Required
Name of the store.
address
string
Required
Physical address of the store.
state
string
Required
State where the store is located.
city
string
Required
City where the store is located.
pincode
string
Required
Postal code (pincode) of the store's location.
country
string
Required
Country where the store is situated.
phone
string
Required
Contact phone number for the store.
fulfillment_channel
string
Required
Type of fulfillment channel used by the store.
location_type
string
Required
Type of location e.g., warehouse, high_street
Enum
company_id
number
Required
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Required
Boolean indicating whether the store is currently active
tags
array of string
Required
Array of tags associated with the store
prices
object
Required
Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
Properties
amount_paid
number
Required
Amount paid by the customer
refund_amount
number
Required
Amount to be refunded on cancellation and return
price_marked
number
Required
The indicated price or value assigned to an item before any discounts or adjustments
cod_charges
number
Required
The fee associated with the COD order
discount
number
Required
The total amount discounted from the original MRP/actual price
cashback_applied
number
Required
Cashback applied on the order
delivery_charge
number
Required
The fee associated with the delivery service for transporting the item to its destination
fynd_credits
number
Required
Credits provided by Fynd
cashback
number
Required
Cashback points
price_effective
number
Required
MRP - Initial Seller provided discount
refund_credit
number
Required
Refund credits provided to the customer
value_of_good
number
Required
Effective selling price - Product GST Amount
coupon_value
number
Required
Stores the coupon value as shown in the cart
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
promotion_effective_discount
number
Required
Effective promotion discount including promotions given by seller and Platform
fynd_promotion_effective_discount
number
Required
Promotion discount given by Platform/fynd
seller_promotion_effective_discount
number
Required
Promotion discount given by the seller
cn_refund_amount
number
Required
Amount to be refunded through credit note
gift_price
number
Required
Gift card amount used
amount_paid_roundoff
number
Amount paid rounded off
payments
object
Required
Object containing payment mode and payment breakup
Properties
id
number
Required
Unique identifier for the payment mode
mode
string
Required
Type or category of the payment mode (e.g., PP, COD)
logo
string
Required
URL or path to the logo/icon representing the payment mode
display_name
string
Required
Name or label used to display the payment mode
display_priority
number
Required
Priority order for displaying the payment mode
source
string
Required
Merchant of the payment mode (e.g., PartnerPay, JioPp)
is_active
boolean
Required
Boolean indicating whether the payment mode is currently active
affiliate_details
object
Required
Application related details like config, order_id, shipment id
Properties
id
string|number
Required
Identifier for the application, can be application_id or extension_id
affiliate_bag_id
string
Required
Identifier assigned by the application for the bag
affiliate_order_id
string
Required
Identifier of the order assigned by the application
company_affiliate_tag
string
Required
Tag associated with the bag from the application's company
affiliate_id
string
Required
Identifier for the application, can be application_id or extension_id
affiliate_shipment_id
string
Required
Identifier of the shipment assigned by the application
affiliate_store_id
string
Required
Identifier of the store assigned by the application
pdf_links
object
Required
PDF Links pushed by the application or extension
Properties
label_type
string
Required
Label type - external
invoice_type
string
Required
Invoice type - external
label
string
Label URL provided by the application or extension
invoice
string
Invoice URL provided by the application or extension
config
object
Required
Application configuration details
Properties
id
string|number
Identifier for the application, can be application_id or extension_id
name
string
Application name
token
null|string
Application token - deprecated
dp_assignment
boolean
Flag indicating whether auto DP assignment should happen from system
app_company_id
number|null|string
ID of the company from which order was placed
article_assignment
object
The article assignment settings
Properties
strategy
string
Enum
level
string
Enum
force_reassignment
boolean
Indicates whether force reassignment is enabled
sales_channel_logo
string
Logo URL of the application to which order belongs
ordering_channel_logo
string
Logo URL of the ordering channel
post_order_reassignment
boolean
Indicates whether post-order reassignment is enabled
dp_details
object
Required
Delivery Partner details
Properties
id
string|number|null
Required
Unique identifier for the delivery partner
name
string|null
Required
Name of the delivery partner
awb_no
string|null
Required
Airway Bill (AWB) number associated with the delivery
eway_bill_id
string|null
Required
Electronic Way Bill (E-way Bill) ID for the delivery
track_url
string|null
Required
URL to track the delivery status or shipment details
gst_tag
string|null
Required
GST tag of the shipment
extension_id
string|null
Required
Unique Identifier of Courier partner Extension
scheme_id
string|null
Required
Unique identifier of a Courier partner scheme
courier_partner_slug
string|null
Required
Unique identifier containing extension_id and scheme_id
rto_address
object
Required
The address to which shipment should be delivered in case of RTO
Properties
company_id
number
Required
ID of the company fulfilling the shipment
id
number
Required
ID of the store where RTO should happen
name
string
Required
A string representing the store's name
store_address_json
object
Required
Store address details
Properties
version
string
Address version, to be deprecated
contact_person
string
Name of the contact person associated with the address
address
string
"A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
address1
string
"A string representing the first line of the address, typically containing street or building information"
address2
string
"A string representing the second line of the address, which can be used for additional address details if needed"
name
string
A string representing the store's name
area
string
A string specifying the locality or area associated with the address
area_code
string
Area code of the address
area_code_slug
string
Unique identifier or slug for the area code associated with the address
landmark
string
"A string representing a prominent nearby landmark that aids in locating the address"
city
string
A string denoting the city or municipality of the address
state
string
A string indicating the state or province of the address
country
string
A string indicating the country of the address
pincode
string
A string indicating the postal code or PIN code of the address area
longitude
number|string
The longitude of the address
sector
string
A string specifying the sector or district of the address if applicable
latitude
number|string
The latitude of the address
phone
string
Mobile phone number of recipient associated with the address
email
string
Email of the recipient associated with the address
address_type
string
Type of address (e.g., home, office, registered)
address_category
string
Category or classification of the address
created_at
string
| date-time
Date and time when the address was created
updated_at
string
| date-time
Date and time when the address was last updated
country_phone_code
string|null
Phone code for the country of the address
country_iso_code
string
ISO code representing the country of the address
country_code
string
ISO code representing the country of the address
display_address
string
Formatted display version of the address
code
string
Required
Alphanumeric code representing the store
location_type
string
Required
Type of location e.g., warehouse, high_street
address1
string
Required
"A string representing the first line of the address, typically containing street or building information"
address2
string
Required
"A string representing the second line of the address, which can be used for additional address details if needed"
display_address
string
Required
Formatted display version of the address
city
string
Required
A string denoting the city or municipality of the address
state
string
Required
A string indicating the state or province of the address
sector
string
Required
A string specifying the sector or district of the address if applicable
country
string
Required
A string indicating the country of the address
pincode
string
Required
A string indicating the postal code or PIN code of the address area
store_email
string
Required
Email of the recipient associated with the store
contact_person
string
Required
Name of the contact person associated with the address
phone
string
Required
Mobile phone number of recipient associated with the address
weight
object
Required
Weight details for item/article
Properties
value
number
Required
unit
string
Required
shipment_gst
object
Required
GST details associated with the shipment
Properties
value_of_good
number
Required
Effective selling price - Product GST Amount
gst_fee
number
Required
The fee associated with Goods and Services Tax (GST) for a product or service
brand_calculated_amount
number
Required
Effective selling price - Brand's additional discounts
tax_collected_at_source
number
Required
The tax amount collected at the source of income or transaction
gstin_code
string|null
Required
The Goods and Services Tax Identification Number (GSTIN) associated with a business entity
store_invoice_id
string|null
Required
Invoice ID attached to the shipment
credit_note_id
string|null
Required
Credit Note ID attached to the shipment
order_created
string
Required
Order creation timestamp
payment_methods
object
Required
"Object containing payment methods used for placing an order. The key will be 'COD' if Cash on Delivery (COD) payment mode is used, and the corresponding value will provide information about that payment method. If Partner Pay is used, the key will be 'PP' with relevant payment details."
payment_info
array of Undefined Type
Required
"Array of object containing payment methods used for placing an order."
order
object
Required
Order level details
Properties
ordering_channel
string
Required
The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing.
ordering_source
string
Nullable
To uniquely identify the source through which order has been placed.
Enum
affiliate_order_date
string|null
| date-time
Required
Order creation timestamp at application/extension end
affiliate_order_id
string
Required
Identifier of the order assigned by the application
fynd_order_id
string
Required
System generated unique identifier of the order
mode_of_payment
string
Required
Unique identifier associated with the payment mode
source
string
Required
Ordering source eg. affiliate, fynd
total_order_value
number
Required
Total order value
collect_by
string
Required
Whomsoever collected the money
refund_by
string
Required
Whomsoever will refund the money
order_value
number
Required
Value of the order
order_source
string
Required
Ordering source eg. affiliate, fynd
journey_type
string|null
Required
Journey type forward or return
einvoice_info
object
Required
Einvoice info if e-invoice is applicable
Properties
credit_note
object
Details of the reverse credit note einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
invoice
object
Details of the forward invoice einvoice
Properties
ack_dt
string
Date and time when the e-invoice acknowledgment was received
ack_no
string
Acknowledgment number assigned to the e-invoice upon successful submission
irn
string
Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice
signed_invoice
string
he digitally signed version of the e-invoice, ensuring authenticity and integrity
signed_qr_code
string
QR code containing the signed e-invoice data for quick and secure verification purposes
message
array of object
Error Message received from JioGSt
Array of Properties
ErrorCode
string|null
ErrorMessage
string|null
lock_status
boolean
Required
Lock status of the shipment
original_bag_list
array of number
Required
List of Bag ids when the order was created
shipment_update_time
number
Required
Last shipment update time
previous_shipment_id
string|null
Required
"ID of the shipment from which current shipment was created, this is populated whenever the shipment goes into negative state transition"
fyndstore_emp
object
Required
Fynd store employee details
ordering_store
object
Required
Store details from which order was placed in case of StoreOS
Properties
id
number
Unique identifier for the store.
code
string
Alphanumeric code representing the store.
name
string
Name of the store.
address
string
Physical address of the store.
state
string
State where the store is located.
city
string
City where the store is located.
pincode
string
Postal code (pincode) of the store's location.
country
string
Country where the store is situated.
phone
string
Contact phone number for the store.
fulfillment_channel
string
Type of fulfillment channel used by the store.
location_type
string
Type of location e.g., warehouse, high_street
Enum
company_id
number
Identifier of the company responsible for fulfilling shipments from this store
is_active
boolean
Boolean indicating whether the store is currently active
tags
array of string
Array of tags associated with the store
coupon
object
Required
Coupon related details
cart_info
object
Required
Cart related information
Properties
cart_id
string
Required
The unique identifier of the cart
cart_uid
number
Required
UID associated with the cart
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      "properties": {
77        "shipment": {
78          "type": "object",
79          "properties": {
80            "status": {
81              "type": "string",
82              "description": "Webhook shipment status, i.e., either create or update"
83            },
84            "shipment_status": {
85              "type": "object",
86              "description": "Status of the shipment indicating its current stage",
87              "properties": {
88                "created_at": {
89                  "type": "string",
90                  "description": "Shipment status created timestamp"
91                },
92                "created_ts": {
93                  "type": "string",
94                  "description": "Shipment status created timestamp"
95                },
96                "id": {
97                  "type": "number",
98                  "description": "Unique identifier associated with the shipment's status object"
99                },
100                "updated_ts": {
101                  "type": "string",
102                  "description": "Shipment status updated timestamp"
103                },
104                "bag_list": {
105                  "type": "array",
106                  "description": "List of Bag ids transitioned in this shipment's status",
107                  "items": {
108                    "type": "string"
109                  }
110                },
111                "shipment_id": {
112                  "type": "string",
113                  "description": "Unique shipment no. that is auto-generated"
114                },
115                "status": {
116                  "type": "string",
117                  "description": "Shipment's operational status"
118                },
119                "current_shipment_status": {
120                  "type": "string",
121                  "description": "Current shipment's status; it can be financial, logistics or operational"
122                },
123                "status_created_at": {
124                  "type": "string"
125                }
126              },
127              "required": [
128                "created_at",
129                "created_ts",
130                "id",
131                "updated_ts",
132                "bag_list",
133                "shipment_id",
134                "status",
135                "current_shipment_status",
136                "status_created_at"
137              ]
138            },
139            "application_id": {
140              "type": "string",
141              "description": "ID of the sales channel to which the shipment belongs"
142            },
143            "shipment_id": {
144              "type": "string",
145              "description": "Unique shipment no. that is auto-generated"
146            },
147            "company_id": {
148              "type": "number",
149              "description": "ID of the company fulfilling the shipment"
150            },
151            "app_company_id": {
152              "type": [
153                "number",
154                "null",
155                "string"
156              ],
157              "description": "ID of the company from which order was placed"
158            },
159            "order_id": {
160              "type": "string",
161              "description": "Unique ID of order in which the shipment is present"
162            },
163            "merchant_id": {
164              "type": "string",
165              "description": "Unique merchant id"
166            },
167            "user": {
168              "type": "object",
169              "description": "Purchaser's details such as name, last name, mobile no. and email",
170              "properties": {
171                "email": {
172                  "type": [
173                    "string",
174                    "null"
175                  ],
176                  "description": "Email address of the purchaser user"
177                },
178                "id": {
179                  "type": [
180                    "number",
181                    "null"
182                  ],
183                  "description": "Unique identifier for the purchaser user within the system"
184                },
185                "gender": {
186                  "type": [
187                    "null",
188                    "string"
189                  ],
190                  "description": "Gender of the purchaser user (e.g., male, female, other)"
191                },
192                "first_name": {
193                  "type": "string",
194                  "description": "First name of the purchaser user"
195                },
196                "external_customer_id": {
197                  "type": [
198                    "string",
199                    "null"
200                  ],
201                  "description": "External identifier associated with the purchaser user in another system"
202                },
203                "mobile": {
204                  "type": [
205                    "string",
206                    "null"
207                  ],
208                  "description": "Mobile phone number of the purchaser user"
209                },
210                "last_name": {
211                  "type": "string",
212                  "description": "Last name of the purchaser user"
213                },
214                "mongo_user_id": {
215                  "type": [
216                    "string",
217                    "null"
218                  ],
219                  "description": "User's object ID in mongodb collection"
220                },
221                "user_oid": {
222                  "type": [
223                    "string",
224                    "null"
225                  ],
226                  "description": "User Object ID assigned within the system"
227                },
228                "country_phone_code": {
229                  "type": [
230                    "string",
231                    "null"
232                  ],
233                  "description": "Country phone code associated with the purchaser user's mobile number"
234                },
235                "is_anonymous_user": {
236                  "type": "boolean",
237                  "description": "Flag indicating whether the user is anonymous"
238                }
239              }
240            },
241            "delivery_address": {
242              "type": "object",
243              "description": "Address where the shipment is to be delivered",
244              "properties": {
245                "area": {
246                  "type": "string",
247                  "description": "A string specifying the locality or area associated with the address"
248                },
249                "city": {
250                  "type": "string",
251                  "description": "A string denoting the city or municipality of the address"
252                },
253                "name": {
254                  "type": "string",
255                  "description": "A string representing the recipient's name or the organization name associated with the address"
256                },
257                "email": {
258                  "type": "string",
259                  "description": "Email of the recipient associated with the delivery address"
260                },
261                "phone": {
262                  "type": "string",
263                  "description": "Mobile phone number of recipient associated with the delivery address"
264                },
265                "state": {
266                  "type": "string",
267                  "description": "A string indicating the state or province of the delivery address"
268                },
269                "address": {
270                  "type": "string",
271                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
272                },
273                "country": {
274                  "type": "string",
275                  "description": "A string indicating the country of the address"
276                },
277                "pincode": {
278                  "type": "string",
279                  "description": "A string indicating the postal code or PIN code of the address area"
280                },
281                "user_id": {
282                  "type": [
283                    "number",
284                    "null"
285                  ],
286                  "description": "Unique identifier for the fulfilling user within the system"
287                },
288                "version": {
289                  "type": "string",
290                  "description": "Address version, to be deprecated"
291                },
292                "address1": {
293                  "type": "string",
294                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
295                },
296                "address2": {
297                  "type": "string",
298                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
299                },
300                "landmark": {
301                  "type": "string",
302                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
303                },
304                "latitude": {
305                  "type": [
306                    "number",
307                    "string"
308                  ],
309                  "description": "The latitude of the address"
310                },
311                "area_code": {
312                  "type": "string",
313                  "x-not-enum": true,
314                  "description": "Area code of the address"
315                },
316                "last_name": {
317                  "type": "string",
318                  "description": "Last name of the recipient associated with the delivery address"
319                },
320                "longitude": {
321                  "type": [
322                    "number",
323                    "string"
324                  ],
325                  "description": "The longitude of the address"
326                },
327                "created_at": {
328                  "type": "string",
329                  "format": "date-time",
330                  "description": "Date and time when the delivery address was created"
331                },
332                "first_name": {
333                  "type": "string",
334                  "description": "First name of the recipient associated with the delivery address"
335                },
336                "updated_at": {
337                  "type": "string",
338                  "format": "date-time",
339                  "description": "Date and time when the delivery address was last updated"
340                },
341                "address_type": {
342                  "type": "string",
343                  "x-not-enum": true,
344                  "description": "Type of address (e.g., home, office, registered)"
345                },
346                "geo_location": {
347                  "required": [],
348                  "description": "Geographic coordinates (latitude and longitude) of the delivery address",
349                  "type": "object",
350                  "properties": {
351                    "latitude": {
352                      "type": [
353                        "number",
354                        "string"
355                      ],
356                      "description": "The latitude of the geolocation"
357                    },
358                    "longitude": {
359                      "type": [
360                        "number",
361                        "string"
362                      ],
363                      "description": "The longitude of the geolocation"
364                    }
365                  }
366                },
367                "area_code_slug": {
368                  "type": "string",
369                  "description": "Unique identifier or slug for the area code associated with the address"
370                },
371                "contact_person": {
372                  "type": "string",
373                  "description": "Name of the contact person associated with the delivery address"
374                },
375                "display_address": {
376                  "type": "string",
377                  "description": "Formatted display version of the delivery address"
378                },
379                "address_category": {
380                  "type": "string",
381                  "x-not-enum": true,
382                  "description": "Category or classification of the delivery address"
383                },
384                "country_iso_code": {
385                  "type": "string",
386                  "x-not-enum": true,
387                  "description": "ISO code representing the country of the delivery address"
388                },
389                "country_phone_code": {
390                  "type": [
391                    "string",
392                    "null"
393                  ],
394                  "x-not-enum": true,
395                  "description": "Phone code for the country of the delivery address"
396                }
397              }
398            },
399            "billing_address": {
400              "type": "object",
401              "description": "Address by which the invoice is created",
402              "properties": {
403                "area": {
404                  "type": "string",
405                  "description": "A string specifying the locality or area associated with the address"
406                },
407                "city": {
408                  "type": "string",
409                  "description": "A string denoting the city or municipality of the address"
410                },
411                "name": {
412                  "type": "string",
413                  "description": "A string representing the billing user's name or the organization name associated with the address"
414                },
415                "email": {
416                  "type": "string",
417                  "description": "Email address associated with the billing address user"
418                },
419                "phone": {
420                  "type": "string",
421                  "description": "Phone number associated with the billing address user"
422                },
423                "state": {
424                  "type": "string",
425                  "description": "A string indicating the state or province of the billing address"
426                },
427                "address": {
428                  "type": "string",
429                  "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
430                },
431                "country": {
432                  "type": "string",
433                  "description": "A string indicating the country of the address"
434                },
435                "pincode": {
436                  "type": "string",
437                  "description": "A string indicating the postal code or PIN code of the address area"
438                },
439                "version": {
440                  "type": "string",
441                  "description": "Address version, to be deprecated"
442                },
443                "address1": {
444                  "type": "string",
445                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
446                },
447                "address2": {
448                  "type": "string",
449                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
450                },
451                "landmark": {
452                  "type": "string",
453                  "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
454                },
455                "latitude": {
456                  "type": [
457                    "number",
458                    "string"
459                  ],
460                  "description": "The latitude of the address"
461                },
462                "area_code": {
463                  "type": "string",
464                  "x-not-enum": true,
465                  "description": "Area code of the address"
466                },
467                "last_name": {
468                  "type": "string",
469                  "description": "Last name of the individual associated with the billing address"
470                },
471                "longitude": {
472                  "type": [
473                    "number",
474                    "string"
475                  ],
476                  "description": "The longitude of the address"
477                },
478                "created_at": {
479                  "type": "string",
480                  "format": "date-time",
481                  "description": "Date and time when the billing address was created"
482                },
483                "first_name": {
484                  "type": "string",
485                  "description": "First name of the individual associated with the billing address"
486                },
487                "updated_at": {
488                  "type": "string",
489                  "format": "date-time",
490                  "description": "Date and time when the billing address was last updated"
491                },
492                "address_type": {
493                  "type": "string",
494                  "x-not-enum": true,
495                  "description": "Type of address (e.g., home, office, registered)"
496                },
497                "geo_location": {
498                  "required": [],
499                  "description": "Geographic coordinates (latitude and longitude) of the billing address",
500                  "type": "object",
501                  "properties": {
502                    "latitude": {
503                      "type": [
504                        "number",
505                        "string"
506                      ],
507                      "description": "The latitude of the geolocation"
508                    },
509                    "longitude": {
510                      "type": [
511                        "number",
512                        "string"
513                      ],
514                      "description": "The longitude of the geolocation"
515                    }
516                  }
517                },
518                "area_code_slug": {
519                  "type": "string",
520                  "description": "Unique identifier or slug for the area code associated with the address"
521                },
522                "contact_person": {
523                  "type": "string",
524                  "description": "Name of the contact person associated with the billing address"
525                },
526                "display_address": {
527                  "type": "string",
528                  "description": "Formatted display version of the billing address"
529                },
530                "address_category": {
531                  "type": "string",
532                  "x-not-enum": true,
533                  "description": "Category or classification of the delivery address"
534                },
535                "country_iso_code": {
536                  "type": "string",
537                  "x-not-enum": true,
538                  "description": "ISO code representing the country of the delivery address"
539                },
540                "country_phone_code": {
541                  "type": [
542                    "string",
543                    "null"
544                  ],
545                  "x-not-enum": true,
546                  "description": "Phone code for the country of the delivery address"
547                }
548              }
549            },
550            "delivery_partner_details": {
551              "type": "object",
552              "description": "Delivery Partner details",
553              "properties": {
554                "id": {
555                  "type": [
556                    "string",
557                    "number",
558                    "null"
559                  ],
560                  "description": "Unique identifier for the delivery partner"
561                },
562                "name": {
563                  "type": [
564                    "string",
565                    "null"
566                  ],
567                  "description": "Name of the delivery partner"
568                },
569                "awb_no": {
570                  "type": [
571                    "string",
572                    "null"
573                  ],
574                  "description": "Airway Bill (AWB) number associated with the delivery"
575                },
576                "eway_bill_id": {
577                  "type": [
578                    "string",
579                    "null"
580                  ],
581                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
582                },
583                "track_url": {
584                  "type": [
585                    "string",
586                    "null"
587                  ],
588                  "description": "URL to track the delivery status or shipment details"
589                },
590                "gst_tag": {
591                  "type": [
592                    "string",
593                    "null"
594                  ],
595                  "description": "GST tag of the shipment"
596                },
597                "extension_id": {
598                  "type": [
599                    "string",
600                    "null"
601                  ],
602                  "description": "Unique Identifier of Courier partner Extension"
603                },
604                "scheme_id": {
605                  "type": [
606                    "string",
607                    "null"
608                  ],
609                  "description": "Unique identifier of a Courier partner scheme"
610                },
611                "courier_partner_slug": {
612                  "type": [
613                    "string",
614                    "null"
615                  ],
616                  "description": "Unique identifier containing extension_id and scheme_id"
617                }
618              },
619              "required": [
620                "id",
621                "name",
622                "awb_no",
623                "eway_bill_id",
624                "track_url",
625                "gst_tag",
626                "extension_id",
627                "scheme_id",
628                "courier_partner_slug"
629              ]
630            },
631            "bags": {
632              "type": "array",
633              "description": "Details of all the products/articles in a shipment",
634              "items": {
635                "type": "object",
636                "properties": {
637                  "financial_breakup": {
638                    "type": "array",
639                    "description": "Financial breakup of an item",
640                    "items": {
641                      "type": "object",
642                      "properties": {
643                        "brand_calculated_amount": {
644                          "type": "number",
645                          "description": "Effective selling price  - Brand's additional discounts"
646                        },
647                        "discount": {
648                          "type": "number",
649                          "description": "The total amount discounted from the original MRP/actual price"
650                        },
651                        "gst_fee": {
652                          "type": "number",
653                          "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
654                        },
655                        "gst_tax_percentage": {
656                          "type": "number",
657                          "description": "The percentage rate of GST applied to a product or service"
658                        },
659                        "gst_tag": {
660                          "type": [
661                            "string",
662                            "null"
663                          ],
664                          "description": "Type of GST applied - IGST, CGST, SGST"
665                        },
666                        "hsn_code": {
667                          "type": [
668                            "string",
669                            "null"
670                          ],
671                          "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
672                        },
673                        "identifiers": {
674                          "type": "object",
675                          "description": "Product identifiers",
676                          "properties": {
677                            "sku_code": {
678                              "type": "string",
679                              "description": "SKU code of the product"
680                            }
681                          }
682                        },
683                        "price_marked": {
684                          "type": "number",
685                          "description": "The indicated price or value assigned to an item before any discounts or adjustments"
686                        },
687                        "tax_collected_at_source": {
688                          "type": "number",
689                          "description": "The tax amount collected at the source of income or transaction"
690                        },
691                        "tcs_percentage": {
692                          "type": "number",
693                          "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
694                        },
695                        "total_units": {
696                          "type": "number",
697                          "description": "Total number of units of the item"
698                        },
699                        "value_of_good": {
700                          "type": "number",
701                          "description": "Effective selling price - Product GST Amount"
702                        },
703                        "item_name": {
704                          "type": "string",
705                          "description": "The name of the item being referenced"
706                        },
707                        "size": {
708                          "type": "string",
709                          "description": "The physical dimensions or specifications of the item, indicating its size or measurements"
710                        }
711                      },
712                      "required": [
713                        "brand_calculated_amount",
714                        "discount",
715                        "gst_fee",
716                        "gst_tax_percentage",
717                        "gst_tag",
718                        "hsn_code",
719                        "identifiers",
720                        "price_marked",
721                        "tax_collected_at_source",
722                        "tcs_percentage",
723                        "total_units",
724                        "value_of_good",
725                        "item_name",
726                        "size"
727                      ]
728                    }
729                  },
730                  "entity_type": {
731                    "type": "string"
732                  },
733                  "item": {
734                    "type": "object",
735                    "description": "Item details",
736                    "properties": {
737                      "l3_category_name": {
738                        "type": "string",
739                        "description": "The name of the level 3 category to which the item belongs"
740                      },
741                      "l1_category_id": {
742                        "type": "number",
743                        "description": "ID representing the level 2 category classification of the item"
744                      },
745                      "code": {
746                        "type": "string",
747                        "description": "A unique alphanumeric identifier assigned to a specific item for inventory and tracking purposes"
748                      },
749                      "branch_url": {
750                        "type": [
751                          "null",
752                          "string"
753                        ],
754                        "description": "Branch URL"
755                      },
756                      "l2_category": {
757                        "type": "array",
758                        "items": {
759                          "type": "string",
760                          "x-not-enum": true,
761                          "description": "The name of the level 2 category to which the item belongs"
762                        }
763                      },
764                      "l3_category": {
765                        "type": "number",
766                        "x-not-enum": true,
767                        "description": "ID representing the level 3 category classification of the item"
768                      },
769                      "last_updated_at": {
770                        "type": "string",
771                        "format": "date-time",
772                        "description": "Timestamp when the item was last updated"
773                      },
774                      "id": {
775                        "type": "number",
776                        "description": "ID of the item that is being referred"
777                      },
778                      "name": {
779                        "type": "string",
780                        "description": "The name of the item being referenced"
781                      },
782                      "can_return": {
783                        "type": "boolean",
784                        "description": "Flag indicating if the item is eligible for return"
785                      },
786                      "webstore_product_url": {
787                        "type": [
788                          "null",
789                          "string"
790                        ],
791                        "description": "Product URL"
792                      },
793                      "gender": {
794                        "type": [
795                          "null",
796                          "string"
797                        ],
798                        "description": "Gender associated with an item"
799                      },
800                      "l2_category_id": {
801                        "type": "number",
802                        "description": "ID representing the level 2 category classification of the item"
803                      },
804                      "color": {
805                        "type": [
806                          "null",
807                          "string"
808                        ],
809                        "description": "Color associated with and item"
810                      },
811                      "slug_key": {
812                        "type": "string",
813                        "description": "Automatically generated unique slug of the item"
814                      },
815                      "can_cancel": {
816                        "type": "boolean",
817                        "description": "Flag indicating if the item is eligible for cancellation"
818                      },
819                      "attributes": {
820                        "type": "object",
821                        "description": "An object containing descriptive properties of the item",
822                        "properties": {
823                          "name": {
824                            "type": "string",
825                            "description": "The name or title of the item"
826                          },
827                          "color": {
828                            "type": "string",
829                            "description": "The color description of the item"
830                          },
831                          "essential": {
832                            "type": "string",
833                            "description": "Indicates whether the item is considered essential"
834                          },
835                          "brand_name": {
836                            "type": "string",
837                            "description": "The brand name of the item"
838                          },
839                          "primary_color": {
840                            "type": "string",
841                            "description": "The primary color of the item"
842                          },
843                          "primary_color_hex": {
844                            "type": "string",
845                            "description": "The hexadecimal code representing the primary color"
846                          },
847                          "primary-colour-hex-code": {
848                            "type": "string",
849                            "description": "The hexadecimal code representing the primary color"
850                          },
851                          "media": {
852                            "type": "array",
853                            "description": "An array containing media files associated with the item",
854                            "items": {
855                              "type": "object"
856                            }
857                          }
858                        }
859                      },
860                      "brand_id": {
861                        "type": "number",
862                        "description": "The unique identifier associated with the brand of the item"
863                      },
864                      "brand": {
865                        "type": "string",
866                        "description": "The brand or manufacturer of the item"
867                      },
868                      "l1_category": {
869                        "type": "array",
870                        "items": {
871                          "type": "string",
872                          "x-not-enum": true,
873                          "description": "The name of the level 1 category to which the item belongs"
874                        }
875                      },
876                      "department_id": {
877                        "type": "number",
878                        "description": "The unique identifier representing the department or category to which the item belongs"
879                      },
880                      "size": {
881                        "type": "string",
882                        "description": "The size or dimensions of the item"
883                      },
884                      "image": {
885                        "type": "array",
886                        "items": {
887                          "type": "string",
888                          "description": "Url of the item's image"
889                        }
890                      }
891                    }
892                  },
893                  "brand": {
894                    "type": "object",
895                    "description": "Brand's information",
896                    "properties": {
897                      "credit_note_allowed": {
898                        "type": "boolean",
899                        "description": "If a credit note ID needs to be generated by the system"
900                      },
901                      "created_on": {
902                        "type": "string",
903                        "description": "Date and time when the brand was registered or created"
904                      },
905                      "id": {
906                        "type": "number",
907                        "description": "Unique identifier assigned to the brand for reference and identification"
908                      },
909                      "logo": {
910                        "type": "string",
911                        "description": "Visual representation or emblem associated with the brand"
912                      },
913                      "modified_on": {
914                        "type": "string",
915                        "description": "Date and time of the most recent update or modification to the brand's information"
916                      },
917                      "is_virtual_invoice": {
918                        "type": "boolean",
919                        "description": "If invoice ID needs to be generated by the system"
920                      },
921                      "brand_name": {
922                        "type": "string",
923                        "description": "Name or title of the brand used for identification and representation"
924                      }
925                    },
926                    "required": [
927                      "credit_note_allowed",
928                      "created_on",
929                      "id",
930                      "logo",
931                      "modified_on",
932                      "is_virtual_invoice",
933                      "brand_name"
934                    ]
935                  },
936                  "bag_id": {
937                    "type": "number"
938                  },
939                  "article": {
940                    "type": "object",
941                    "description": "Details of the article",
942                    "properties": {
943                      "identifiers": {
944                        "type": "object",
945                        "description": "Product identifiers",
946                        "properties": {
947                          "sku_code": {
948                            "type": "string"
949                          }
950                        }
951                      },
952                      "esp_modified": {
953                        "type": [
954                          "string",
955                          "boolean"
956                        ],
957                        "description": "Flag representing if effective selling price has been modified"
958                      },
959                      "size": {
960                        "type": "string",
961                        "description": "The physical dimensions or specifications of the article, indicating its size or measurements"
962                      },
963                      "code": {
964                        "type": "string",
965                        "description": "A unique alphanumeric identifier assigned to a specific article for inventory and tracking purposes"
966                      },
967                      "set": {
968                        "description": "Details of the set article containing size distribution",
969                        "type": "object",
970                        "properties": {
971                          "quantity": {
972                            "type": "integer",
973                            "description": "Number of units present"
974                          },
975                          "size_distribution": {
976                            "type": "object",
977                            "description": "Object indicating the distribution of size and quantity of a set article",
978                            "properties": {
979                              "sizes": {
980                                "type": "array",
981                                "description": "Array indicating size wise units present in a set article",
982                                "items": {
983                                  "type": "object",
984                                  "description": "Object indicating the size and quantity distribution of a set article",
985                                  "properties": {
986                                    "pieces": {
987                                      "type": "integer",
988                                      "description": "Number of units of a particular size"
989                                    },
990                                    "size": {
991                                      "type": "string",
992                                      "description": "Size of the article"
993                                    }
994                                  }
995                                }
996                              }
997                            }
998                          }
999                        }
1000                      },
1001                      "is_set": {
1002                        "type": [
1003                          "string",
1004                          "boolean"
1005                        ],
1006                        "description": "A boolean indicating whether the article is a set"
1007                      },
1008                      "seller_identifier": {
1009                        "type": "string",
1010                        "description": "Seller's identifier of the article"
1011                      },
1012                      "return_config": {
1013                        "type": "object",
1014                        "description": "Return configuration details of the article",
1015                        "properties": {
1016                          "time": {
1017                            "type": "number",
1018                            "description": "Number indicating number of hours or days"
1019                          },
1020                          "unit": {
1021                            "type": "string",
1022                            "description": "String indicating the unit of the time, eg. days, hours"
1023                          },
1024                          "returnable": {
1025                            "type": "boolean",
1026                            "description": "Flag indicating whether product is returnable or not"
1027                          }
1028                        },
1029                        "required": [
1030                          "time",
1031                          "unit",
1032                          "returnable"
1033                        ]
1034                      },
1035                      "_id": {
1036                        "type": "string",
1037                        "description": "DB generated ID of the article"
1038                      },
1039                      "uid": {
1040                        "type": "string",
1041                        "description": "UID of the article"
1042                      },
1043                      "child_details": {
1044                        "type": [
1045                          "object",
1046                          "array"
1047                        ],
1048                        "description": "Child article details if any",
1049                        "properties": {},
1050                        "required": []
1051                      },
1052                      "dimensions": {
1053                        "description": "The dimension object of the article/item",
1054                        "required": [],
1055                        "type": "object",
1056                        "properties": {
1057                          "height": {
1058                            "type": [
1059                              "number",
1060                              "null"
1061                            ],
1062                            "description": "The height of the product"
1063                          },
1064                          "width": {
1065                            "type": [
1066                              "number",
1067                              "null"
1068                            ],
1069                            "description": "The width of the product"
1070                          },
1071                          "is_default": {
1072                            "type": [
1073                              "boolean",
1074                              "null"
1075                            ],
1076                            "description": "Whether the dimension is the default one or not"
1077                          },
1078                          "unit": {
1079                            "type": [
1080                              "string",
1081                              "null"
1082                            ],
1083                            "description": "The unit of dimension"
1084                          },
1085                          "length": {
1086                            "type": [
1087                              "number",
1088                              "null"
1089                            ],
1090                            "description": "The length of the product"
1091                          }
1092                        }
1093                      },
1094                      "weight": {
1095                        "required": [],
1096                        "type": "object",
1097                        "description": "Object containing weight details of item/article",
1098                        "properties": {
1099                          "unit": {
1100                            "type": "string",
1101                            "description": "The unit of weight",
1102                            "example": "kg"
1103                          },
1104                          "shipping": {
1105                            "type": "number",
1106                            "description": "The shipping weight of the product",
1107                            "example": 1.5
1108                          },
1109                          "is_default": {
1110                            "type": "boolean",
1111                            "description": "Whether the weight is the default one or not",
1112                            "example": true
1113                          }
1114                        }
1115                      },
1116                      "currency": {
1117                        "type": "object",
1118                        "description": "Order currency details",
1119                        "properties": {
1120                          "code": {
1121                            "type": "string",
1122                            "description": "Currency code"
1123                          },
1124                          "rate": {
1125                            "type": "number",
1126                            "description": "The conversion rate value"
1127                          }
1128                        },
1129                        "required": []
1130                      },
1131                      "expiration_date": {}
1132                    },
1133                    "required": [
1134                      "identifiers",
1135                      "esp_modified",
1136                      "size",
1137                      "code",
1138                      "set",
1139                      "is_set",
1140                      "seller_identifier",
1141                      "return_config",
1142                      "_id",
1143                      "uid",
1144                      "child_details",
1145                      "dimensions",
1146                      "weight",
1147                      "currency",
1148                      "expiration_date"
1149                    ]
1150                  },
1151                  "current_operational_status": {
1152                    "type": "object",
1153                    "properties": {
1154                      "created_at": {
1155                        "type": "string",
1156                        "format": "date-time",
1157                        "description": "Date and time when the shipment status record was created"
1158                      },
1159                      "created_ts": {
1160                        "type": "string",
1161                        "description": "Timestamp indicating the exact time when the shipment status record was created"
1162                      },
1163                      "id": {
1164                        "type": "number",
1165                        "description": "Unique identifier for the shipment status record"
1166                      },
1167                      "kafka_sync": {
1168                        "type": "boolean",
1169                        "description": "Flag indicating whether the shipment status update has been sync with Kafka"
1170                      },
1171                      "updated_ts": {
1172                        "type": "string",
1173                        "description": "Timestamp indicating the last time the shipment status record was updated"
1174                      },
1175                      "updated_at": {
1176                        "type": "string",
1177                        "format": "date-time",
1178                        "description": "Date and time of the most recent update to the shipment status record"
1179                      },
1180                      "delivery_partner_id": {
1181                        "type": [
1182                          "integer",
1183                          "null"
1184                        ],
1185                        "description": "Unique identifier of delivery partner"
1186                      },
1187                      "shipment_id": {
1188                        "type": "string",
1189                        "description": "Unique shipment no. that is auto-generated"
1190                      },
1191                      "store_id": {
1192                        "type": "number",
1193                        "description": "ID of the fulfilling store of the shipment"
1194                      },
1195                      "status": {
1196                        "type": "string",
1197                        "description": "Current operational status of the shipment"
1198                      },
1199                      "bag_id": {
1200                        "type": "number",
1201                        "description": "The unique identifier associated with the bag"
1202                      },
1203                      "state_id": {
1204                        "type": "number",
1205                        "description": "The unique identifier associated with the state"
1206                      },
1207                      "state_type": {
1208                        "type": "string",
1209                        "enum": [
1210                          "operational",
1211                          "logistics",
1212                          "financial"
1213                        ],
1214                        "description": "Type of the state - operational, logistics, financial"
1215                      },
1216                      "delivery_awb_number": {
1217                        "type": [
1218                          "string",
1219                          "null"
1220                        ],
1221                        "description": "Airway Bill (AWB) number associated with the delivery"
1222                      },
1223                      "bag_state_mapper": {
1224                        "type": "object",
1225                        "description": "Object representing properties of the state",
1226                        "properties": {
1227                          "journey_type": {
1228                            "type": [
1229                              "string",
1230                              "null"
1231                            ],
1232                            "enum": [
1233                              "forward",
1234                              "return"
1235                            ],
1236                            "description": "Journey type can be forward or return"
1237                          },
1238                          "app_display_name": {
1239                            "type": "string",
1240                            "description": "The display name of a shipment status as it appears on the sale channel's website"
1241                          },
1242                          "state_type": {
1243                            "type": "string",
1244                            "enum": [
1245                              "operational",
1246                              "logistics",
1247                              "financial"
1248                            ],
1249                            "description": "Type of the state - operational, logistics, financial"
1250                          },
1251                          "app_state_name": {
1252                            "type": "string",
1253                            "description": "The slug of a shipment status from the sale channel's front"
1254                          },
1255                          "name": {
1256                            "type": "string",
1257                            "description": "The slug of a shipment status from the platform's front"
1258                          },
1259                          "app_facing": {
1260                            "type": "boolean",
1261                            "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1262                          },
1263                          "id": {
1264                            "type": "number",
1265                            "description": "The unique identifier associated with the state"
1266                          },
1267                          "display_name": {
1268                            "type": "string",
1269                            "description": "The display name of a shipment status as it appears on the platform"
1270                          },
1271                          "is_active": {
1272                            "type": "boolean",
1273                            "description": "A boolean flag indicating whether a state is active or not"
1274                          }
1275                        },
1276                        "required": [
1277                          "journey_type",
1278                          "app_display_name",
1279                          "state_type",
1280                          "app_state_name",
1281                          "name",
1282                          "app_facing",
1283                          "id",
1284                          "display_name",
1285                          "is_active"
1286                        ]
1287                      },
1288                      "reasons": {
1289                        "type": "array",
1290                        "items": {
1291                          "type": "object",
1292                          "properties": {
1293                            "slug": {
1294                              "type": "string",
1295                              "description": "System generated slug"
1296                            },
1297                            "display_name": {
1298                              "type": "string",
1299                              "description": "Text that is displayed on the application front"
1300                            },
1301                            "id": {
1302                              "type": "integer",
1303                              "description": "System generated ID of the reason object"
1304                            },
1305                            "state": {
1306                              "type": [
1307                                "integer",
1308                                "string"
1309                              ],
1310                              "description": "State associated with the reason"
1311                            },
1312                            "text": {
1313                              "type": "string",
1314                              "description": "Reason text"
1315                            },
1316                            "quantity": {
1317                              "type": "integer",
1318                              "description": "No of quantity that is being cancelled"
1319                            },
1320                            "inventory_flag": {
1321                              "type": "boolean",
1322                              "description": "Inventory depletion action to be taken or not"
1323                            }
1324                          }
1325                        },
1326                        "description": "Reasons associated with the current shipment's status"
1327                      },
1328                      "action_user": {
1329                        "description": "Details of the user who initiated the change in the shipment's status",
1330                        "required": [],
1331                        "type": "object",
1332                        "properties": {
1333                          "title": {
1334                            "type": "string",
1335                            "description": "The title of the user eg. Staff, Admin",
1336                            "example": "Staff"
1337                          },
1338                          "user_id": {
1339                            "type": "string",
1340                            "description": "System generated ID associated with the user",
1341                            "example": "23546659"
1342                          },
1343                          "user_name": {
1344                            "type": "string",
1345                            "description": "System generated username associated with the user",
1346                            "example": "65967faf620ff7c9db513d9c"
1347                          },
1348                          "order_role": {
1349                            "type": "string",
1350                            "description": "Order role associated with the user eg. company_operation, store_manager",
1351                            "example": "full_access"
1352                          },
1353                          "employee_code": {
1354                            "type": "string",
1355                            "x-not-enum": true,
1356                            "description": "Employee code associated with the user",
1357                            "example": "EM-102"
1358                          }
1359                        }
1360                      }
1361                    },
1362                    "required": [
1363                      "created_at",
1364                      "created_ts",
1365                      "id",
1366                      "kafka_sync",
1367                      "updated_ts",
1368                      "updated_at",
1369                      "delivery_partner_id",
1370                      "shipment_id",
1371                      "store_id",
1372                      "status",
1373                      "bag_id",
1374                      "state_id",
1375                      "state_type",
1376                      "delivery_awb_number",
1377                      "bag_state_mapper",
1378                      "reasons",
1379                      "action_user"
1380                    ]
1381                  },
1382                  "affiliate_bag_details": {
1383                    "type": "object",
1384                    "description": "Object containing external bag details like external order id, external bag id",
1385                    "properties": {
1386                      "affiliate_bag_id": {
1387                        "type": "string",
1388                        "description": "External bag id"
1389                      },
1390                      "affiliate_order_id": {
1391                        "type": "string",
1392                        "description": "External order id"
1393                      }
1394                    },
1395                    "required": [
1396                      "affiliate_bag_id",
1397                      "affiliate_order_id"
1398                    ]
1399                  },
1400                  "payment_methods": {
1401                    "type": "object",
1402                    "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
1403                  },
1404                  "quantity": {
1405                    "type": "number",
1406                    "description": "Total quantity of the article present in the bag."
1407                  },
1408                  "prices": {
1409                    "type": "object",
1410                    "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
1411                    "properties": {
1412                      "price_effective": {
1413                        "type": "number",
1414                        "description": "MRP - Initial Seller provided discount"
1415                      },
1416                      "discount": {
1417                        "type": "number",
1418                        "description": "The total amount discounted from the original MRP/actual price"
1419                      },
1420                      "amount_paid": {
1421                        "type": "number",
1422                        "description": "Amount paid by the customer"
1423                      },
1424                      "coupon_effective_discount": {
1425                        "type": "number",
1426                        "description": "Coupon provided by brand or seller"
1427                      },
1428                      "delivery_charge": {
1429                        "type": "number",
1430                        "description": "The fee associated with the delivery service for transporting the item to its destination"
1431                      },
1432                      "fynd_credits": {
1433                        "type": "number",
1434                        "description": "Credits provided by Fynd"
1435                      },
1436                      "cod_charges": {
1437                        "type": "number",
1438                        "description": "The fee associated with the COD order"
1439                      },
1440                      "refund_credit": {
1441                        "type": "number",
1442                        "description": "Refund credits provided to the customer"
1443                      },
1444                      "cashback": {
1445                        "type": "number",
1446                        "description": "Cashback points"
1447                      },
1448                      "refund_amount": {
1449                        "type": "number",
1450                        "description": "Amount to be refunded on cancellation and return"
1451                      },
1452                      "added_to_fynd_cash": {
1453                        "type": "boolean",
1454                        "description": "Flag indicating whether fynd cash has been used"
1455                      },
1456                      "cashback_applied": {
1457                        "type": "number",
1458                        "description": "Cashback applied on the order"
1459                      },
1460                      "gst_tax_percentage": {
1461                        "type": "number",
1462                        "description": "The percentage rate of GST applied to a product or service"
1463                      },
1464                      "value_of_good": {
1465                        "type": "number",
1466                        "description": "Effective selling price - Product GST Amount"
1467                      },
1468                      "price_marked": {
1469                        "type": "number",
1470                        "description": "The indicated price or value assigned to an item before any discounts or adjustments"
1471                      },
1472                      "transfer_price": {
1473                        "type": "number",
1474                        "description": "article"
1475                      },
1476                      "brand_calculated_amount": {
1477                        "type": "number",
1478                        "description": "Price Effective - Coupon Discount (Seller) - Promotion (Seller)"
1479                      },
1480                      "tax_collected_at_source": {
1481                        "type": "number",
1482                        "description": "The tax amount collected at the source of income or transaction"
1483                      },
1484                      "tcs_percentage": {
1485                        "type": "number",
1486                        "description": "The percentage rate of Tax Collected at Source (TCS) applied to a transaction"
1487                      },
1488                      "promotion_effective_discount": {
1489                        "type": "number",
1490                        "description": "Effective promotion discount including promotions given by seller and Platform"
1491                      },
1492                      "gift_price": {
1493                        "type": "number",
1494                        "description": "Gift card amount used"
1495                      },
1496                      "coupon_value": {
1497                        "type": "number",
1498                        "description": "Stores the coupon value as shown in the cart"
1499                      },
1500                      "seller_promotion_effective_discount": {
1501                        "type": "number",
1502                        "description": "Promotion discount given by the seller"
1503                      },
1504                      "fynd_promotion_effective_discount": {
1505                        "type": "number",
1506                        "description": "Promotion discount given by Platform/fynd"
1507                      },
1508                      "amount_paid_roundoff": {
1509                        "type": "number",
1510                        "description": "Amount paid rounded off"
1511                      }
1512                    },
1513                    "required": [
1514                      "price_effective",
1515                      "discount",
1516                      "amount_paid",
1517                      "coupon_effective_discount",
1518                      "delivery_charge",
1519                      "fynd_credits",
1520                      "cod_charges",
1521                      "refund_credit",
1522                      "cashback",
1523                      "refund_amount",
1524                      "added_to_fynd_cash",
1525                      "cashback_applied",
1526                      "gst_tax_percentage",
1527                      "value_of_good",
1528                      "price_marked",
1529                      "transfer_price",
1530                      "brand_calculated_amount",
1531                      "tax_collected_at_source",
1532                      "tcs_percentage",
1533                      "promotion_effective_discount",
1534                      "gift_price",
1535                      "coupon_value",
1536                      "seller_promotion_effective_discount",
1537                      "fynd_promotion_effective_discount",
1538                      "amount_paid_roundoff"
1539                    ]
1540                  },
1541                  "order_created": {
1542                    "type": "string",
1543                    "description": "Order creation timestamp"
1544                  },
1545                  "gst_details": {
1546                    "type": "object",
1547                    "description": "GST details associated with the bag",
1548                    "properties": {
1549                      "gstin_code": {
1550                        "type": [
1551                          "string",
1552                          "null"
1553                        ],
1554                        "x-not-enum": true,
1555                        "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
1556                      },
1557                      "gst_tag": {
1558                        "type": [
1559                          "string",
1560                          "null"
1561                        ],
1562                        "description": "Type of GST applied - IGST, CGST, SGST"
1563                      },
1564                      "hsn_code": {
1565                        "type": [
1566                          "string",
1567                          "null"
1568                        ],
1569                        "x-not-enum": true,
1570                        "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
1571                      },
1572                      "value_of_good": {
1573                        "type": "number",
1574                        "description": "Effective selling price - Product GST Amount"
1575                      },
1576                      "gst_tax_percentage": {
1577                        "type": "number",
1578                        "description": "The percentage rate of GST applied to a product or service"
1579                      },
1580                      "is_default_hsn_code": {
1581                        "type": "boolean"
1582                      },
1583                      "brand_calculated_amount": {
1584                        "type": "number",
1585                        "description": "Effective selling price  - Brand's additional discounts"
1586                      },
1587                      "tax_collected_at_source": {
1588                        "type": "number",
1589                        "description": "The tax amount collected at the source of income or transaction"
1590                      },
1591                      "hsn_code_id": {
1592                        "type": [
1593                          "string",
1594                          "null"
1595                        ],
1596                        "description": "The unique identifier associated with HSN code"
1597                      },
1598                      "gst_fee": {
1599                        "type": "number",
1600                        "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
1601                      },
1602                      "igst_tax_percentage": {
1603                        "type": "number",
1604                        "description": "Percentage of Integrated Goods and Services Tax (IGST) applied to the transaction, applicable for inter-state transactions"
1605                      },
1606                      "sgst_tax_percentage": {
1607                        "type": "number",
1608                        "description": "Percentage of State Goods and Services Tax (SGST) applied to the transaction, applicable for intra-state transactions within the same state"
1609                      },
1610                      "cgst_tax_percentage": {
1611                        "type": "number",
1612                        "description": "Percentage of Central Goods and Services Tax (CGST) applied to the transaction, applicable for intra-state transactions within the same state"
1613                      },
1614                      "igst_gst_fee": {
1615                        "type": [
1616                          "string",
1617                          "number"
1618                        ],
1619                        "description": "Amount of Integrated Goods and Services Tax (IGST) fee applied to the transaction, relevant for inter-state transactions"
1620                      },
1621                      "cgst_gst_fee": {
1622                        "type": "string",
1623                        "description": "Amount of Central Goods and Services Tax (CGST) fee applied to the transaction, applicable for intra-state transactions within the same state"
1624                      },
1625                      "sgst_gst_fee": {
1626                        "type": "string",
1627                        "description": "Amount of State Goods and Services Tax (SGST) fee applied to the transaction, relevant for intra-state transactions within the same state"
1628                      }
1629                    },
1630                    "required": [
1631                      "gstin_code",
1632                      "gst_tag",
1633                      "hsn_code",
1634                      "value_of_good",
1635                      "gst_tax_percentage",
1636                      "is_default_hsn_code",
1637                      "brand_calculated_amount",
1638                      "tax_collected_at_source",
1639                      "hsn_code_id",
1640                      "gst_fee",
1641                      "igst_tax_percentage",
1642                      "sgst_tax_percentage",
1643                      "cgst_tax_percentage",
1644                      "igst_gst_fee",
1645                      "cgst_gst_fee",
1646                      "sgst_gst_fee"
1647                    ]
1648                  },
1649                  "line_number": {
1650                    "type": "number",
1651                    "description": "Unique identifier associated with each bag in a shipment"
1652                  },
1653                  "applied_promos": {
1654                    "type": "array",
1655                    "description": "Details of the applied promotions",
1656                    "items": {
1657                      "type": "object",
1658                      "properties": {
1659                        "promo_id": {
1660                          "type": "string",
1661                          "description": "Promotion id"
1662                        },
1663                        "buy_rules": {
1664                          "description": "Buy rules for promotions",
1665                          "type": "array",
1666                          "items": {
1667                            "type": "object",
1668                            "properties": {
1669                              "item_criteria": {
1670                                "type": "object",
1671                                "description": "Item criteria of promotion"
1672                              },
1673                              "cart_conditions": {
1674                                "type": "object",
1675                                "description": "Cart conditions details for promotion"
1676                              }
1677                            }
1678                          }
1679                        },
1680                        "offer_text": {
1681                          "type": "string",
1682                          "description": "Offer text of current promotion"
1683                        },
1684                        "promotion_group": {
1685                          "type": "string",
1686                          "description": "Promotion group for the promotion"
1687                        },
1688                        "mrp_promotion": {
1689                          "type": "boolean",
1690                          "description": "If applied promotion is applied on product MRP or ESP"
1691                        },
1692                        "promotion_name": {
1693                          "type": "string",
1694                          "description": "Promotion name of current promotion"
1695                        },
1696                        "amount": {
1697                          "type": "number",
1698                          "description": "Per unit discount amount applied with current promotion"
1699                        },
1700                        "discount_rules": {
1701                          "description": "Discount rules for promotions",
1702                          "type": "array",
1703                          "items": {
1704                            "type": "object",
1705                            "properties": {
1706                              "matched_buy_rules": {
1707                                "type": "array",
1708                                "description": "Matched buy rules for promotion",
1709                                "items": {
1710                                  "type": "string"
1711                                }
1712                              },
1713                              "raw_offer": {
1714                                "type": "object",
1715                                "description": "raw offer details for promotion"
1716                              },
1717                              "offer": {
1718                                "type": "object",
1719                                "description": "offer for promotion"
1720                              },
1721                              "item_criteria": {
1722                                "type": "object",
1723                                "description": "Item criteria of promotion"
1724                              }
1725                            }
1726                          }
1727                        },
1728                        "ownership": {
1729                          "type": "object",
1730                          "description": "Ownership of promotion",
1731                          "properties": {
1732                            "payable_category": {
1733                              "type": "string",
1734                              "x-not-enum": true,
1735                              "description": "promo amount payable category"
1736                            },
1737                            "payable_by": {
1738                              "type": "string",
1739                              "description": "promo amount bearable party"
1740                            }
1741                          }
1742                        },
1743                        "article_quantity": {
1744                          "type": "integer",
1745                          "description": "Quantity of article on which promotion is applicable"
1746                        },
1747                        "applied_free_articles": {
1748                          "description": "Applied free article for free gift item promotions",
1749                          "type": "array",
1750                          "items": {
1751                            "type": "object",
1752                            "properties": {
1753                              "free_gift_item_details": {
1754                                "description": "Free gift items details",
1755                                "type": "object",
1756                                "properties": {
1757                                  "item_slug": {
1758                                    "type": "string",
1759                                    "description": "item slug"
1760                                  },
1761                                  "item_name": {
1762                                    "type": "string",
1763                                    "description": "Item name"
1764                                  },
1765                                  "item_price_details": {
1766                                    "type": "object",
1767                                    "description": "item price details"
1768                                  },
1769                                  "item_brand_name": {
1770                                    "type": "string",
1771                                    "description": "item brand name"
1772                                  },
1773                                  "item_id": {
1774                                    "type": "integer",
1775                                    "description": "Item id"
1776                                  },
1777                                  "item_images_url": {
1778                                    "type": "array",
1779                                    "description": "item images URL",
1780                                    "items": {
1781                                      "type": "string"
1782                                    }
1783                                  }
1784                                }
1785                              },
1786                              "parent_item_identifier": {
1787                                "type": "string",
1788                                "description": "Parent item identifier for free article"
1789                              },
1790                              "quantity": {
1791                                "type": "integer",
1792                                "description": "Free article quantity"
1793                              },
1794                              "article_id": {
1795                                "type": "string",
1796                                "description": "free article id"
1797                              }
1798                            }
1799                          }
1800                        },
1801                        "promotion_type": {
1802                          "type": "string",
1803                          "x-not-enum": true,
1804                          "description": "Promotion type of current promotion"
1805                        },
1806                        "meta": {
1807                          "type": "object",
1808                          "additionalProperties": true,
1809                          "description": "Meta object for extra data"
1810                        },
1811                        "code": {
1812                          "type": [
1813                            "string",
1814                            "null"
1815                          ],
1816                          "description": "Promotion code"
1817                        }
1818                      }
1819                    }
1820                  }
1821                },
1822                "required": [
1823                  "financial_breakup",
1824                  "entity_type",
1825                  "item",
1826                  "brand",
1827                  "bag_id",
1828                  "article",
1829                  "current_operational_status",
1830                  "affiliate_bag_details",
1831                  "payment_methods",
1832                  "quantity",
1833                  "prices",
1834                  "order_created",
1835                  "gst_details",
1836                  "line_number",
1837                  "applied_promos"
1838                ]
1839              }
1840            },
1841            "bag_status_history": {
1842              "type": "array",
1843              "description": "Records the changes in status for a bag, providing a timeline of events and transitions",
1844              "items": {
1845                "type": "object",
1846                "properties": {
1847                  "created_at": {
1848                    "type": "string",
1849                    "format": "date-time",
1850                    "description": "Date and time when the bag status history record was created."
1851                  },
1852                  "created_ts": {
1853                    "type": "string",
1854                    "description": "Timestamp indicating the exact time when the bag status history record was created"
1855                  },
1856                  "id": {
1857                    "type": "number",
1858                    "description": "Unique identifier for the bag status history record"
1859                  },
1860                  "kafka_sync": {
1861                    "type": "boolean",
1862                    "description": "Flag indicating whether the bag status history update has been sync with Kafka"
1863                  },
1864                  "updated_ts": {
1865                    "type": "string",
1866                    "description": "Timestamp indicating the last time the bag status history record was updated"
1867                  },
1868                  "updated_at": {
1869                    "format": "date-time",
1870                    "type": "string",
1871                    "description": "Date and time of the most recent update to the bag status history record"
1872                  },
1873                  "delivery_partner_id": {
1874                    "type": [
1875                      "integer",
1876                      "null"
1877                    ],
1878                    "description": "Unique identifier of delivery partner"
1879                  },
1880                  "shipment_id": {
1881                    "type": "string",
1882                    "description": "Unique shipment no. that is auto-generated"
1883                  },
1884                  "store_id": {
1885                    "type": "number",
1886                    "description": "Store id associated with the bag"
1887                  },
1888                  "status": {
1889                    "type": "string",
1890                    "description": "Webhook shipment status, i.e., either create or update"
1891                  },
1892                  "bag_id": {
1893                    "type": "number",
1894                    "description": "The unique identifier associated with the bag"
1895                  },
1896                  "state_id": {
1897                    "type": "number",
1898                    "description": "The unique identifier associated with the state"
1899                  },
1900                  "state_type": {
1901                    "type": "string",
1902                    "enum": [
1903                      "operational",
1904                      "logistics",
1905                      "financial"
1906                    ],
1907                    "description": "Type of the state - operational, logistics, financial"
1908                  },
1909                  "delivery_awb_number": {
1910                    "type": [
1911                      "string",
1912                      "null"
1913                    ],
1914                    "description": "Airway Bill (AWB) number associated with the delivery"
1915                  },
1916                  "bag_state_mapper": {
1917                    "type": "object",
1918                    "description": "Object representing properties of the state",
1919                    "properties": {
1920                      "journey_type": {
1921                        "type": [
1922                          "string",
1923                          "null"
1924                        ],
1925                        "enum": [
1926                          "forward",
1927                          "return"
1928                        ],
1929                        "description": "Journey type can be forward or return"
1930                      },
1931                      "app_display_name": {
1932                        "type": "string",
1933                        "description": "The display name of a shipment status as it appears on the sale channel's website"
1934                      },
1935                      "state_type": {
1936                        "type": "string",
1937                        "enum": [
1938                          "operational",
1939                          "logistics",
1940                          "financial"
1941                        ],
1942                        "description": "Type of the state - operational, logistics, financial"
1943                      },
1944                      "app_state_name": {
1945                        "type": "string",
1946                        "description": "The slug of a shipment status from the sale channel's front"
1947                      },
1948                      "name": {
1949                        "type": "string",
1950                        "description": "The slug of a shipment status from the platform's front"
1951                      },
1952                      "app_facing": {
1953                        "type": "boolean",
1954                        "description": "A boolean flag indicating whether a particular shipment status should be visible on the sale channel's website"
1955                      },
1956                      "id": {
1957                        "type": "number",
1958                        "description": "The unique identifier associated with the state"
1959                      },
1960                      "display_name": {
1961                        "type": "string",
1962                        "description": "The display name of a shipment status as it appears on the platform"
1963                      },
1964                      "is_active": {
1965                        "type": "boolean",
1966                        "description": "A boolean flag indicating whether a state is active or not"
1967                      }
1968                    },
1969                    "required": [
1970                      "journey_type",
1971                      "app_display_name",
1972                      "state_type",
1973                      "app_state_name",
1974                      "name",
1975                      "app_facing",
1976                      "id",
1977                      "display_name",
1978                      "is_active"
1979                    ]
1980                  },
1981                  "reasons": {
1982                    "type": "array",
1983                    "items": {
1984                      "type": "object",
1985                      "properties": {
1986                        "slug": {
1987                          "type": "string",
1988                          "description": "System generated slug"
1989                        },
1990                        "display_name": {
1991                          "type": "string",
1992                          "description": "Text that is displayed on the application front"
1993                        },
1994                        "id": {
1995                          "type": "integer",
1996                          "description": "System generated ID of the reason object"
1997                        },
1998                        "state": {
1999                          "type": [
2000                            "integer",
2001                            "string"
2002                          ],
2003                          "description": "State associated with the reason"
2004                        },
2005                        "text": {
2006                          "type": "string",
2007                          "description": "Reason text"
2008                        },
2009                        "quantity": {
2010                          "type": "integer",
2011                          "description": "No of quantity that is being cancelled"
2012                        },
2013                        "inventory_flag": {
2014                          "type": "boolean",
2015                          "description": "Inventory depletion action to be taken or not"
2016                        }
2017                      }
2018                    },
2019                    "description": "Reasons associated with the current shipment's status"
2020                  },
2021                  "action_user": {
2022                    "type": "object",
2023                    "properties": {
2024                      "title": {
2025                        "type": "string",
2026                        "description": "The title of the user eg. Staff, Admin",
2027                        "example": "Staff"
2028                      },
2029                      "user_id": {
2030                        "type": "string",
2031                        "description": "System generated ID associated with the user",
2032                        "example": "23546659"
2033                      },
2034                      "user_name": {
2035                        "type": "string",
2036                        "description": "System generated username associated with the user",
2037                        "example": "65967faf620ff7c9db513d9c"
2038                      },
2039                      "order_role": {
2040                        "type": "string",
2041                        "description": "Order role associated with the user eg. company_operation, store_manager",
2042                        "example": "full_access"
2043                      },
2044                      "employee_code": {
2045                        "type": "string",
2046                        "x-not-enum": true,
2047                        "description": "Employee code associated with the user",
2048                        "example": "EM-102"
2049                      }
2050                    },
2051                    "required": []
2052                  }
2053                },
2054                "required": [
2055                  "created_at",
2056                  "created_ts",
2057                  "id",
2058                  "kafka_sync",
2059                  "updated_ts",
2060                  "updated_at",
2061                  "delivery_partner_id",
2062                  "shipment_id",
2063                  "store_id",
2064                  "status",
2065                  "bag_id",
2066                  "state_id",
2067                  "state_type",
2068                  "delivery_awb_number",
2069                  "bag_state_mapper",
2070                  "reasons",
2071                  "action_user"
2072                ]
2073              }
2074            },
2075            "fulfilling_store": {
2076              "description": "Details of the store responsible for fulfilling the order",
2077              "type": "object",
2078              "properties": {
2079                "id": {
2080                  "type": "number",
2081                  "description": "Unique identifier for the store."
2082                },
2083                "code": {
2084                  "type": "string",
2085                  "description": "Alphanumeric code representing the store."
2086                },
2087                "name": {
2088                  "type": "string",
2089                  "description": "Name of the store."
2090                },
2091                "address": {
2092                  "type": "string",
2093                  "description": "Physical address of the store."
2094                },
2095                "state": {
2096                  "type": "string",
2097                  "description": "State where the store is located."
2098                },
2099                "city": {
2100                  "type": "string",
2101                  "description": "City where the store is located."
2102                },
2103                "pincode": {
2104                  "type": "string",
2105                  "description": "Postal code (pincode) of the store's location."
2106                },
2107                "country": {
2108                  "type": "string",
2109                  "description": "Country where the store is situated."
2110                },
2111                "phone": {
2112                  "type": "string",
2113                  "description": "Contact phone number for the store."
2114                },
2115                "fulfillment_channel": {
2116                  "type": "string",
2117                  "description": "Type of fulfillment channel used by the store."
2118                },
2119                "location_type": {
2120                  "type": "string",
2121                  "enum": [
2122                    "high_street",
2123                    "mall",
2124                    "store",
2125                    "warehouse"
2126                  ],
2127                  "description": "Type of location e.g., warehouse, high_street"
2128                },
2129                "company_id": {
2130                  "type": "number",
2131                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
2132                },
2133                "is_active": {
2134                  "type": "boolean",
2135                  "description": "Boolean indicating whether the store is currently active"
2136                },
2137                "tags": {
2138                  "type": "array",
2139                  "items": {
2140                    "type": "string"
2141                  },
2142                  "description": "Array of tags associated with the store"
2143                }
2144              },
2145              "required": [
2146                "id",
2147                "code",
2148                "name",
2149                "address",
2150                "state",
2151                "city",
2152                "pincode",
2153                "country",
2154                "phone",
2155                "fulfillment_channel",
2156                "location_type",
2157                "company_id",
2158                "is_active",
2159                "tags"
2160              ]
2161            },
2162            "prices": {
2163              "type": "object",
2164              "description": "Details of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment",
2165              "properties": {
2166                "amount_paid": {
2167                  "type": "number",
2168                  "description": "Amount paid by the customer"
2169                },
2170                "refund_amount": {
2171                  "type": "number",
2172                  "description": "Amount to be refunded on cancellation and return"
2173                },
2174                "price_marked": {
2175                  "type": "number",
2176                  "description": "The indicated price or value assigned to an item before any discounts or adjustments"
2177                },
2178                "cod_charges": {
2179                  "type": "number",
2180                  "description": "The fee associated with the COD order"
2181                },
2182                "discount": {
2183                  "type": "number",
2184                  "description": "The total amount discounted from the original MRP/actual price"
2185                },
2186                "cashback_applied": {
2187                  "type": "number",
2188                  "description": "Cashback applied on the order"
2189                },
2190                "delivery_charge": {
2191                  "type": "number",
2192                  "description": "The fee associated with the delivery service for transporting the item to its destination"
2193                },
2194                "fynd_credits": {
2195                  "type": "number",
2196                  "description": "Credits provided by Fynd"
2197                },
2198                "cashback": {
2199                  "type": "number",
2200                  "description": "Cashback points"
2201                },
2202                "price_effective": {
2203                  "type": "number",
2204                  "description": "MRP - Initial Seller provided discount"
2205                },
2206                "refund_credit": {
2207                  "type": "number",
2208                  "description": "Refund credits provided to the customer"
2209                },
2210                "value_of_good": {
2211                  "type": "number",
2212                  "description": "Effective selling price - Product GST Amount"
2213                },
2214                "coupon_value": {
2215                  "type": "number",
2216                  "description": "Stores the coupon value as shown in the cart"
2217                },
2218                "tax_collected_at_source": {
2219                  "type": "number",
2220                  "description": "The tax amount collected at the source of income or transaction"
2221                },
2222                "promotion_effective_discount": {
2223                  "type": "number",
2224                  "description": "Effective promotion discount including promotions given by seller and Platform"
2225                },
2226                "fynd_promotion_effective_discount": {
2227                  "type": "number",
2228                  "description": "Promotion discount given by Platform/fynd"
2229                },
2230                "seller_promotion_effective_discount": {
2231                  "type": "number",
2232                  "description": "Promotion discount given by the seller"
2233                },
2234                "cn_refund_amount": {
2235                  "type": "number",
2236                  "description": "Amount to be refunded through credit note"
2237                },
2238                "gift_price": {
2239                  "type": "number",
2240                  "description": "Gift card amount used"
2241                },
2242                "amount_paid_roundoff": {
2243                  "type": "number",
2244                  "description": "Amount paid rounded off"
2245                }
2246              },
2247              "required": [
2248                "amount_paid",
2249                "refund_amount",
2250                "price_marked",
2251                "cod_charges",
2252                "discount",
2253                "cashback_applied",
2254                "delivery_charge",
2255                "fynd_credits",
2256                "cashback",
2257                "price_effective",
2258                "refund_credit",
2259                "value_of_good",
2260                "coupon_value",
2261                "tax_collected_at_source",
2262                "promotion_effective_discount",
2263                "fynd_promotion_effective_discount",
2264                "seller_promotion_effective_discount",
2265                "cn_refund_amount",
2266                "gift_price"
2267              ]
2268            },
2269            "payments": {
2270              "type": "object",
2271              "description": "Object containing payment mode and payment breakup",
2272              "properties": {
2273                "id": {
2274                  "type": "number",
2275                  "description": "Unique identifier for the payment mode"
2276                },
2277                "mode": {
2278                  "type": "string",
2279                  "description": "Type or category of the payment mode (e.g., PP, COD)"
2280                },
2281                "logo": {
2282                  "type": "string",
2283                  "description": "URL or path to the logo/icon representing the payment mode"
2284                },
2285                "display_name": {
2286                  "type": "string",
2287                  "description": "Name or label used to display the payment mode"
2288                },
2289                "display_priority": {
2290                  "type": "number",
2291                  "description": "Priority order for displaying the payment mode"
2292                },
2293                "source": {
2294                  "type": "string",
2295                  "description": "Merchant of the payment mode (e.g., PartnerPay, JioPp)"
2296                },
2297                "is_active": {
2298                  "type": "boolean",
2299                  "description": "Boolean indicating whether the payment mode is currently active"
2300                }
2301              },
2302              "required": [
2303                "id",
2304                "mode",
2305                "logo",
2306                "display_name",
2307                "display_priority",
2308                "source",
2309                "is_active"
2310              ]
2311            },
2312            "affiliate_details": {
2313              "type": "object",
2314              "description": "Application related details like config, order_id, shipment id",
2315              "properties": {
2316                "id": {
2317                  "type": [
2318                    "string",
2319                    "number"
2320                  ],
2321                  "description": "Identifier for the application, can be application_id or extension_id"
2322                },
2323                "affiliate_bag_id": {
2324                  "type": "string",
2325                  "description": "Identifier assigned by the application for the bag"
2326                },
2327                "affiliate_order_id": {
2328                  "type": "string",
2329                  "description": "Identifier of the order assigned by the application"
2330                },
2331                "company_affiliate_tag": {
2332                  "type": "string",
2333                  "description": "Tag associated with the bag from the application's company"
2334                },
2335                "affiliate_id": {
2336                  "type": "string",
2337                  "description": "Identifier for the application, can be application_id or extension_id"
2338                },
2339                "affiliate_shipment_id": {
2340                  "type": "string",
2341                  "description": "Identifier of the shipment assigned by the application"
2342                },
2343                "affiliate_store_id": {
2344                  "type": "string",
2345                  "description": "Identifier of the store assigned by the application"
2346                },
2347                "pdf_links": {
2348                  "type": "object",
2349                  "description": "PDF Links pushed by the application or extension",
2350                  "properties": {
2351                    "label_type": {
2352                      "type": "string",
2353                      "description": "Label type - external"
2354                    },
2355                    "invoice_type": {
2356                      "type": "string",
2357                      "description": "Invoice type - external"
2358                    },
2359                    "label": {
2360                      "type": "string",
2361                      "description": "Label URL provided by the application or extension"
2362                    },
2363                    "invoice": {
2364                      "type": "string",
2365                      "description": "Invoice URL provided by the application or extension"
2366                    }
2367                  },
2368                  "required": [
2369                    "label_type",
2370                    "invoice_type"
2371                  ]
2372                },
2373                "config": {
2374                  "type": "object",
2375                  "description": "Application configuration details",
2376                  "properties": {
2377                    "id": {
2378                      "type": [
2379                        "string",
2380                        "number"
2381                      ],
2382                      "description": "Identifier for the application, can be application_id or extension_id"
2383                    },
2384                    "name": {
2385                      "type": "string",
2386                      "description": "Application name"
2387                    },
2388                    "token": {
2389                      "type": [
2390                        "null",
2391                        "string"
2392                      ],
2393                      "description": "Application token - deprecated"
2394                    },
2395                    "dp_assignment": {
2396                      "type": "boolean",
2397                      "description": "Flag indicating whether auto DP assignment should happen from system"
2398                    },
2399                    "app_company_id": {
2400                      "type": [
2401                        "number",
2402                        "null",
2403                        "string"
2404                      ],
2405                      "description": "ID of the company from which order was placed"
2406                    },
2407                    "article_assignment": {
2408                      "description": "The article assignment settings",
2409                      "type": "object",
2410                      "properties": {
2411                        "strategy": {
2412                          "type": "string",
2413                          "enum": [
2414                            "optimal",
2415                            "low-price"
2416                          ]
2417                        },
2418                        "level": {
2419                          "type": "string",
2420                          "enum": [
2421                            "multi-companies",
2422                            "single-company",
2423                            "single-store"
2424                          ]
2425                        }
2426                      },
2427                      "required": []
2428                    },
2429                    "force_reassignment": {
2430                      "type": "boolean",
2431                      "description": "Indicates whether force reassignment is enabled"
2432                    },
2433                    "sales_channel_logo": {
2434                      "type": "string",
2435                      "description": "Logo URL of the application to which order belongs"
2436                    },
2437                    "ordering_channel_logo": {
2438                      "type": "string",
2439                      "description": "Logo URL of the ordering channel"
2440                    },
2441                    "post_order_reassignment": {
2442                      "type": "boolean",
2443                      "description": "Indicates whether post-order reassignment is enabled"
2444                    }
2445                  }
2446                }
2447              },
2448              "required": [
2449                "id",
2450                "affiliate_bag_id",
2451                "affiliate_order_id",
2452                "company_affiliate_tag",
2453                "affiliate_id",
2454                "affiliate_shipment_id",
2455                "affiliate_store_id",
2456                "pdf_links",
2457                "config"
2458              ]
2459            },
2460            "dp_details": {
2461              "type": "object",
2462              "description": "Delivery Partner details",
2463              "properties": {
2464                "id": {
2465                  "type": [
2466                    "string",
2467                    "number",
2468                    "null"
2469                  ],
2470                  "description": "Unique identifier for the delivery partner"
2471                },
2472                "name": {
2473                  "type": [
2474                    "string",
2475                    "null"
2476                  ],
2477                  "description": "Name of the delivery partner"
2478                },
2479                "awb_no": {
2480                  "type": [
2481                    "string",
2482                    "null"
2483                  ],
2484                  "description": "Airway Bill (AWB) number associated with the delivery"
2485                },
2486                "eway_bill_id": {
2487                  "type": [
2488                    "string",
2489                    "null"
2490                  ],
2491                  "description": "Electronic Way Bill (E-way Bill) ID for the delivery"
2492                },
2493                "track_url": {
2494                  "type": [
2495                    "string",
2496                    "null"
2497                  ],
2498                  "description": "URL to track the delivery status or shipment details"
2499                },
2500                "gst_tag": {
2501                  "type": [
2502                    "string",
2503                    "null"
2504                  ],
2505                  "description": "GST tag of the shipment"
2506                },
2507                "extension_id": {
2508                  "type": [
2509                    "string",
2510                    "null"
2511                  ],
2512                  "description": "Unique Identifier of Courier partner Extension"
2513                },
2514                "scheme_id": {
2515                  "type": [
2516                    "string",
2517                    "null"
2518                  ],
2519                  "description": "Unique identifier of a Courier partner scheme"
2520                },
2521                "courier_partner_slug": {
2522                  "type": [
2523                    "string",
2524                    "null"
2525                  ],
2526                  "description": "Unique identifier containing extension_id and scheme_id"
2527                }
2528              },
2529              "required": [
2530                "id",
2531                "name",
2532                "awb_no",
2533                "eway_bill_id",
2534                "track_url",
2535                "gst_tag",
2536                "extension_id",
2537                "scheme_id",
2538                "courier_partner_slug"
2539              ]
2540            },
2541            "rto_address": {
2542              "type": "object",
2543              "description": "The address to which shipment should be delivered in case of RTO",
2544              "properties": {
2545                "company_id": {
2546                  "type": "number",
2547                  "description": "ID of the company fulfilling the shipment"
2548                },
2549                "id": {
2550                  "type": "number",
2551                  "description": "ID of the store where RTO should happen"
2552                },
2553                "name": {
2554                  "type": "string",
2555                  "description": "A string representing the store's name"
2556                },
2557                "store_address_json": {
2558                  "type": "object",
2559                  "description": "Store address details",
2560                  "properties": {
2561                    "version": {
2562                      "type": "string",
2563                      "description": "Address version, to be deprecated"
2564                    },
2565                    "contact_person": {
2566                      "type": "string",
2567                      "description": "Name of the contact person associated with the address"
2568                    },
2569                    "address": {
2570                      "type": "string",
2571                      "description": "\"A string representing the complete address, combining address line 1,  address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details\""
2572                    },
2573                    "address1": {
2574                      "type": "string",
2575                      "description": "\"A string representing the first line of the address, typically containing street or building information\""
2576                    },
2577                    "address2": {
2578                      "type": "string",
2579                      "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2580                    },
2581                    "name": {
2582                      "type": "string",
2583                      "description": "A string representing the store's name"
2584                    },
2585                    "area": {
2586                      "type": "string",
2587                      "description": "A string specifying the locality or area associated with the address"
2588                    },
2589                    "area_code": {
2590                      "type": "string",
2591                      "x-not-enum": true,
2592                      "description": "Area code of the address"
2593                    },
2594                    "area_code_slug": {
2595                      "type": "string",
2596                      "description": "Unique identifier or slug for the area code associated with the address"
2597                    },
2598                    "landmark": {
2599                      "type": "string",
2600                      "description": "\"A string representing a prominent nearby landmark that aids in locating the address\""
2601                    },
2602                    "city": {
2603                      "type": "string",
2604                      "description": "A string denoting the city or municipality of the address"
2605                    },
2606                    "state": {
2607                      "type": "string",
2608                      "description": "A string indicating the state or province of the address"
2609                    },
2610                    "country": {
2611                      "type": "string",
2612                      "description": "A string indicating the country of the address"
2613                    },
2614                    "pincode": {
2615                      "type": "string",
2616                      "description": "A string indicating the postal code or PIN code of the address area"
2617                    },
2618                    "longitude": {
2619                      "type": [
2620                        "number",
2621                        "string"
2622                      ],
2623                      "description": "The longitude of the address"
2624                    },
2625                    "sector": {
2626                      "type": "string",
2627                      "description": "A string specifying the sector or district of the address if applicable"
2628                    },
2629                    "latitude": {
2630                      "type": [
2631                        "number",
2632                        "string"
2633                      ],
2634                      "description": "The latitude of the address"
2635                    },
2636                    "phone": {
2637                      "type": "string",
2638                      "description": "Mobile phone number of recipient associated with the address"
2639                    },
2640                    "email": {
2641                      "type": "string",
2642                      "description": "Email of the recipient associated with the address"
2643                    },
2644                    "address_type": {
2645                      "type": "string",
2646                      "x-not-enum": true,
2647                      "description": "Type of address (e.g., home, office, registered)"
2648                    },
2649                    "address_category": {
2650                      "type": "string",
2651                      "x-not-enum": true,
2652                      "description": "Category or classification of the address"
2653                    },
2654                    "created_at": {
2655                      "type": "string",
2656                      "format": "date-time",
2657                      "description": "Date and time when the address was created"
2658                    },
2659                    "updated_at": {
2660                      "type": "string",
2661                      "format": "date-time",
2662                      "description": "Date and time when the address was last updated"
2663                    },
2664                    "country_phone_code": {
2665                      "type": [
2666                        "string",
2667                        "null"
2668                      ],
2669                      "x-not-enum": true,
2670                      "description": "Phone code for the country of the address"
2671                    },
2672                    "country_iso_code": {
2673                      "type": "string",
2674                      "x-not-enum": true,
2675                      "description": "ISO code representing the country of the address"
2676                    },
2677                    "country_code": {
2678                      "type": "string",
2679                      "x-not-enum": true,
2680                      "description": "ISO code representing the country of the address"
2681                    },
2682                    "display_address": {
2683                      "type": "string",
2684                      "description": "Formatted display version of the address"
2685                    }
2686                  }
2687                },
2688                "code": {
2689                  "type": "string",
2690                  "description": "Alphanumeric code representing the store"
2691                },
2692                "location_type": {
2693                  "type": "string",
2694                  "x-not-enum": true,
2695                  "description": "Type of location e.g., warehouse, high_street"
2696                },
2697                "address1": {
2698                  "type": "string",
2699                  "description": "\"A string representing the first line of the address, typically containing street or building information\""
2700                },
2701                "address2": {
2702                  "type": "string",
2703                  "description": "\"A string representing the second line of the address, which can be used for additional address details if needed\""
2704                },
2705                "display_address": {
2706                  "type": "string",
2707                  "description": "Formatted display version of the address"
2708                },
2709                "city": {
2710                  "type": "string",
2711                  "description": "A string denoting the city or municipality of the address"
2712                },
2713                "state": {
2714                  "type": "string",
2715                  "description": "A string indicating the state or province of the address"
2716                },
2717                "sector": {
2718                  "type": "string",
2719                  "description": "A string specifying the sector or district of the address if applicable"
2720                },
2721                "country": {
2722                  "type": "string",
2723                  "description": "A string indicating the country of the address"
2724                },
2725                "pincode": {
2726                  "type": "string",
2727                  "description": "A string indicating the postal code or PIN code of the address area"
2728                },
2729                "store_email": {
2730                  "type": "string",
2731                  "description": "Email of the recipient associated with the store"
2732                },
2733                "contact_person": {
2734                  "type": "string",
2735                  "description": "Name of the contact person associated with the address"
2736                },
2737                "phone": {
2738                  "type": "string",
2739                  "description": "Mobile phone number of recipient associated with the address"
2740                }
2741              },
2742              "required": [
2743                "company_id",
2744                "id",
2745                "name",
2746                "store_address_json",
2747                "code",
2748                "location_type",
2749                "address1",
2750                "address2",
2751                "display_address",
2752                "city",
2753                "state",
2754                "sector",
2755                "country",
2756                "pincode",
2757                "store_email",
2758                "contact_person",
2759                "phone"
2760              ]
2761            },
2762            "weight": {
2763              "type": "object",
2764              "description": "Weight details for item/article",
2765              "properties": {
2766                "value": {
2767                  "type": "number"
2768                },
2769                "unit": {
2770                  "type": "string"
2771                }
2772              },
2773              "required": [
2774                "value",
2775                "unit"
2776              ]
2777            },
2778            "shipment_gst": {
2779              "type": "object",
2780              "description": "GST details associated with the shipment",
2781              "properties": {
2782                "value_of_good": {
2783                  "type": "number",
2784                  "description": "Effective selling price - Product GST Amount"
2785                },
2786                "gst_fee": {
2787                  "type": "number",
2788                  "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
2789                },
2790                "brand_calculated_amount": {
2791                  "type": "number",
2792                  "description": "Effective selling price  - Brand's additional discounts"
2793                },
2794                "tax_collected_at_source": {
2795                  "type": "number",
2796                  "description": "The tax amount collected at the source of income or transaction"
2797                },
2798                "gstin_code": {
2799                  "type": [
2800                    "string",
2801                    "null"
2802                  ],
2803                  "x-not-enum": true,
2804                  "description": "The Goods and Services Tax Identification Number (GSTIN) associated with a business entity"
2805                }
2806              },
2807              "required": [
2808                "value_of_good",
2809                "gst_fee",
2810                "brand_calculated_amount",
2811                "tax_collected_at_source",
2812                "gstin_code"
2813              ]
2814            },
2815            "store_invoice_id": {
2816              "type": [
2817                "string",
2818                "null"
2819              ],
2820              "description": "Invoice ID attached to the shipment"
2821            },
2822            "credit_note_id": {
2823              "type": [
2824                "string",
2825                "null"
2826              ],
2827              "description": "Credit Note ID attached to the shipment"
2828            },
2829            "order_created": {
2830              "type": "string",
2831              "description": "Order creation timestamp"
2832            },
2833            "payment_methods": {
2834              "type": "object",
2835              "description": "\"Object containing payment methods used for placing an order.  The key will be 'COD' if Cash on Delivery (COD) payment mode is used,  and the corresponding value will provide information about that payment method.  If Partner Pay is used, the key will be 'PP' with relevant payment details.\""
2836            },
2837            "payment_info": {
2838              "type": "array",
2839              "description": "\"Array of object containing payment methods used for placing an order.\"",
2840              "items": {}
2841            },
2842            "order": {
2843              "type": "object",
2844              "description": "Order level details",
2845              "properties": {
2846                "ordering_channel": {
2847                  "type": "string",
2848                  "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
2849                },
2850                "ordering_source": {
2851                  "type": "string",
2852                  "nullable": true,
2853                  "description": "To uniquely identify the source through which order has been placed.",
2854                  "enum": [
2855                    "storefront",
2856                    "store_os_pos",
2857                    "kiosk",
2858                    "scan_go",
2859                    "smart_trolley",
2860                    "gofynd",
2861                    "uniket",
2862                    "marketplace",
2863                    "social_commerce",
2864                    "ondc",
2865                    "nexus"
2866                  ]
2867                },
2868                "affiliate_order_date": {
2869                  "type": [
2870                    "string",
2871                    "null"
2872                  ],
2873                  "format": "date-time",
2874                  "description": "Order creation timestamp at application/extension end"
2875                },
2876                "affiliate_order_id": {
2877                  "type": "string",
2878                  "description": "Identifier of the order assigned by the application"
2879                },
2880                "fynd_order_id": {
2881                  "type": "string",
2882                  "description": "System generated unique identifier of the order"
2883                },
2884                "mode_of_payment": {
2885                  "type": "string",
2886                  "description": "Unique identifier associated with the payment mode"
2887                },
2888                "source": {
2889                  "type": "string",
2890                  "description": "Ordering source eg. affiliate, fynd"
2891                },
2892                "total_order_value": {
2893                  "type": "number",
2894                  "description": "Total order value"
2895                },
2896                "collect_by": {
2897                  "type": "string",
2898                  "description": "Whomsoever collected the money"
2899                },
2900                "refund_by": {
2901                  "type": "string",
2902                  "description": "Whomsoever will refund the money"
2903                },
2904                "order_value": {
2905                  "type": "number",
2906                  "description": "Value of the order"
2907                }
2908              },
2909              "required": [
2910                "ordering_channel",
2911                "affiliate_order_date",
2912                "affiliate_order_id",
2913                "fynd_order_id",
2914                "mode_of_payment",
2915                "source",
2916                "total_order_value",
2917                "collect_by",
2918                "refund_by",
2919                "order_value"
2920              ]
2921            },
2922            "order_source": {
2923              "type": "string",
2924              "description": "Ordering source eg. affiliate, fynd"
2925            },
2926            "journey_type": {
2927              "type": [
2928                "string",
2929                "null"
2930              ],
2931              "description": "Journey type forward or return"
2932            },
2933            "einvoice_info": {
2934              "type": "object",
2935              "description": "Einvoice info if e-invoice is applicable",
2936              "properties": {
2937                "credit_note": {
2938                  "description": "Details of the reverse credit note einvoice",
2939                  "type": "object",
2940                  "properties": {
2941                    "ack_dt": {
2942                      "type": "string",
2943                      "description": "Date and time when the e-invoice acknowledgment was received"
2944                    },
2945                    "ack_no": {
2946                      "type": "string",
2947                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
2948                    },
2949                    "irn": {
2950                      "type": "string",
2951                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
2952                    },
2953                    "signed_invoice": {
2954                      "type": "string",
2955                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
2956                    },
2957                    "signed_qr_code": {
2958                      "x-not-enum": true,
2959                      "type": "string",
2960                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
2961                    },
2962                    "message": {
2963                      "type": "array",
2964                      "description": "Error Message received from JioGSt",
2965                      "items": {
2966                        "type": "object",
2967                        "properties": {
2968                          "ErrorCode": {
2969                            "type": [
2970                              "string",
2971                              "null"
2972                            ]
2973                          },
2974                          "ErrorMessage": {
2975                            "type": [
2976                              "string",
2977                              "null"
2978                            ]
2979                          }
2980                        }
2981                      }
2982                    }
2983                  }
2984                },
2985                "invoice": {
2986                  "description": "Details of the forward invoice einvoice",
2987                  "type": "object",
2988                  "properties": {
2989                    "ack_dt": {
2990                      "type": "string",
2991                      "description": "Date and time when the e-invoice acknowledgment was received"
2992                    },
2993                    "ack_no": {
2994                      "type": "string",
2995                      "description": "Acknowledgment number assigned to the e-invoice upon successful submission"
2996                    },
2997                    "irn": {
2998                      "type": "string",
2999                      "description": "Invoice Reference Number (IRN) assigned to uniquely identify the e-invoice"
3000                    },
3001                    "signed_invoice": {
3002                      "type": "string",
3003                      "description": "he digitally signed version of the e-invoice, ensuring authenticity and integrity"
3004                    },
3005                    "signed_qr_code": {
3006                      "x-not-enum": true,
3007                      "type": "string",
3008                      "description": "QR code containing the signed e-invoice data for quick and secure verification purposes"
3009                    },
3010                    "message": {
3011                      "type": "array",
3012                      "description": "Error Message received from JioGSt",
3013                      "items": {
3014                        "type": "object",
3015                        "properties": {
3016                          "ErrorCode": {
3017                            "type": [
3018                              "string",
3019                              "null"
3020                            ]
3021                          },
3022                          "ErrorMessage": {
3023                            "type": [
3024                              "string",
3025                              "null"
3026                            ]
3027                          }
3028                        }
3029                      }
3030                    }
3031                  }
3032                }
3033              },
3034              "required": []
3035            },
3036            "lock_status": {
3037              "type": "boolean",
3038              "description": "Lock status of the shipment"
3039            },
3040            "original_bag_list": {
3041              "type": "array",
3042              "items": {
3043                "type": "number"
3044              },
3045              "description": "List of Bag ids when the order was created"
3046            },
3047            "shipment_update_time": {
3048              "type": "number",
3049              "description": "Last shipment update time"
3050            },
3051            "previous_shipment_id": {
3052              "type": [
3053                "string",
3054                "null"
3055              ],
3056              "description": "\"ID of the shipment from which current shipment was created,  this is populated whenever the shipment goes into negative state transition\""
3057            },
3058            "fyndstore_emp": {
3059              "type": "object",
3060              "description": "Fynd store employee details",
3061              "properties": {},
3062              "required": []
3063            },
3064            "ordering_store": {
3065              "description": "Store details from which order was placed in case of StoreOS",
3066              "required": [],
3067              "type": "object",
3068              "properties": {
3069                "id": {
3070                  "type": "number",
3071                  "description": "Unique identifier for the store."
3072                },
3073                "code": {
3074                  "type": "string",
3075                  "description": "Alphanumeric code representing the store."
3076                },
3077                "name": {
3078                  "type": "string",
3079                  "description": "Name of the store."
3080                },
3081                "address": {
3082                  "type": "string",
3083                  "description": "Physical address of the store."
3084                },
3085                "state": {
3086                  "type": "string",
3087                  "description": "State where the store is located."
3088                },
3089                "city": {
3090                  "type": "string",
3091                  "description": "City where the store is located."
3092                },
3093                "pincode": {
3094                  "type": "string",
3095                  "description": "Postal code (pincode) of the store's location."
3096                },
3097                "country": {
3098                  "type": "string",
3099                  "description": "Country where the store is situated."
3100                },
3101                "phone": {
3102                  "type": "string",
3103                  "description": "Contact phone number for the store."
3104                },
3105                "fulfillment_channel": {
3106                  "type": "string",
3107                  "description": "Type of fulfillment channel used by the store."
3108                },
3109                "location_type": {
3110                  "type": "string",
3111                  "enum": [
3112                    "high_street",
3113                    "mall",
3114                    "store",
3115                    "warehouse"
3116                  ],
3117                  "description": "Type of location e.g., warehouse, high_street"
3118                },
3119                "company_id": {
3120                  "type": "number",
3121                  "description": "Identifier of the company responsible for fulfilling shipments from this store"
3122                },
3123                "is_active": {
3124                  "type": "boolean",
3125                  "description": "Boolean indicating whether the store is currently active"
3126                },
3127                "tags": {
3128                  "type": "array",
3129                  "items": {
3130                    "type": "string"
3131                  },
3132                  "description": "Array of tags associated with the store"
3133                }
3134              }
3135            },
3136            "coupon": {
3137              "type": "object",
3138              "description": "Coupon related details",
3139              "properties": {},
3140              "required": []
3141            },
3142            "cart_info": {
3143              "type": "object",
3144              "description": "Cart related information",
3145              "properties": {
3146                "cart_id": {
3147                  "type": "string",
3148                  "description": "The unique identifier of the cart"
3149                },
3150                "cart_uid": {
3151                  "type": "number",
3152                  "description": "UID associated with the cart"
3153                }
3154              },
3155              "required": [
3156                "cart_id",
3157                "cart_uid"
3158              ]
3159            }
3160          },
3161          "required": [
3162            "status",
3163            "shipment_status",
3164            "application_id",
3165            "shipment_id",
3166            "company_id",
3167            "app_company_id",
3168            "order_id",
3169            "merchant_id",
3170            "user",
3171            "delivery_address",
3172            "billing_address",
3173            "delivery_partner_details",
3174            "bags",
3175            "bag_status_history",
3176            "fulfilling_store",
3177            "prices",
3178            "payments",
3179            "affiliate_details",
3180            "dp_details",
3181            "rto_address",
3182            "weight",
3183            "shipment_gst",
3184            "store_invoice_id",
3185            "credit_note_id",
3186            "order_created",
3187            "payment_methods",
3188            "payment_info",
3189            "order",
3190            "order_source",
3191            "journey_type",
3192            "einvoice_info",
3193            "lock_status",
3194            "original_bag_list",
3195            "shipment_update_time",
3196            "previous_shipment_id",
3197            "fyndstore_emp",
3198            "ordering_store",
3199            "coupon",
3200            "cart_info"
3201          ]
3202        }
3203      },
3204      "required": [
3205        "shipment"
3206      ]
3207    }
3208  }
3209}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "0000000000000000cd20af0b03839b95"
5    ],
6    "name": "shipment",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711716048137,
10    "id": "DZlcvyBgMu/zX1n9knpNNfl7lVPsG/Pgqbpyjt+SbhU=",
11    "category": "application"
12  },
13  "company_id": 2411,
14  "application_id": "618a224ce93512680cfd93d0",
15  "contains": [
16    "shipment"
17  ],
18  "payload": {
19    "shipment": {
20      "status": "ready_for_dp_assignment",
21      "shipment_status": {
22        "status": "ready_for_dp_assignment",
23        "created_ts": "2024-03-29T12:40:47Z",
24        "meta": {
25          "request_meta": {},
26          "estimated_sla_ts": "2024-03-31T10:30:00Z",
27          "estimated_sla_time": "2024-03-31T16:00:00",
28          "state_manager_used": "entity"
29        },
30        "updated_ts": "2024-03-29T12:40:47Z",
31        "id": 163729667,
32        "created_at": "2024-03-29T18:10:48+00:00",
33        "shipment_id": "17116842623541524113",
34        "bag_list": [
35          "33814027"
36        ],
37        "current_shipment_status": "ready_for_dp_assignment",
38        "status_created_at": "2024-03-29T18:10:48+00:00"
39      },
40      "application_id": "618a224ce93512680cfd93d0",
41      "shipment_id": "17116842623541524113",
42      "company_id": 2411,
43      "app_company_id": 2411,
44      "order_id": "FYMP66063AA601BFA6A8",
45      "merchant_id": "",
46      "user": {
47        "mongo_user_id": null,
48        "mobile": "1111111111",
49        "external_customer_id": null,
50        "email": "test@example.com",
51        "gender": null,
52        "meta": {
53          "country_phone_code": ""
54        },
55        "id": 17831651,
56        "user_oid": null,
57        "first_name": "test test",
58        "last_name": "",
59        "country_phone_code": "",
60        "is_anonymous_user": false
61      },
62      "delivery_address": {
63        "area": "Delhi",
64        "city": "New Delhi",
65        "name": "test test  ",
66        "email": "test@example.com",
67        "phone": "1111111111",
68        "state": "Delhi",
69        "mobile": "1111111111",
70        "address": "test address",
71        "country": "India",
72        "pincode": "110058",
73        "user_id": 17831651,
74        "version": "1.0",
75        "address1": "test address",
76        "address2": "",
77        "landmark": "",
78        "latitude": 0,
79        "area_code": "",
80        "longitude": 0,
81        "created_at": "2024-03-29T09:21:02+00:00",
82        "first_name": "test test ",
83        "state_code": "DL",
84        "updated_at": "2024-03-29T09:21:02+00:00",
85        "address_type": "home",
86        "geo_location": {},
87        "area_code_slug": "",
88        "contact_person": "test test  ",
89        "display_address": "test address",
90        "address_category": "",
91        "country_iso_code": "IN",
92        "country_phone_code": null
93      },
94      "billing_address": {
95        "area": "Delhi",
96        "city": "New Delhi",
97        "name": "",
98        "email": "test@example.com",
99        "phone": "1111111111",
100        "state": "Delhi",
101        "mobile": "1111111111",
102        "address": "test address",
103        "country": "India",
104        "pincode": "110058",
105        "version": "1.0",
106        "address1": "test address",
107        "address2": "",
108        "landmark": "",
109        "latitude": 0,
110        "area_code": "",
111        "longitude": 0,
112        "created_at": "2024-03-29 09:21:02",
113        "first_name": "test user ",
114        "state_code": "DL",
115        "updated_at": "2024-03-29 09:21:02",
116        "address_type": "home",
117        "geo_location": {},
118        "area_code_slug": "",
119        "contact_person": "test user  ",
120        "display_address": "test address",
121        "address_category": "",
122        "country_iso_code": "IN",
123        "country_phone_code": null
124      },
125      "delivery_partner_details": {
126        "id": null,
127        "name": null,
128        "awb_no": null,
129        "eway_bill_id": null,
130        "track_url": null,
131        "gst_tag": "sgst",
132        "extension_id": null,
133        "scheme_id": null,
134        "courier_partner_slug": null
135      },
136      "bags": [
137        {
138          "financial_breakup": [
139            {
140              "brand_calculated_amount": 399,
141              "discount": 600,
142              "gst_fee": 19,
143              "gst_tax_percentage": 5,
144              "gst_tag": "IGST",
145              "hsn_code": "61099010",
146              "identifiers": {
147                "sku_code": "LTSH00038_B.GREEN_XL"
148              },
149              "price_marked": 999,
150              "tax_collected_at_source": 0,
151              "tcs_percentage": 0,
152              "total_units": 1,
153              "value_of_good": 380,
154              "item_name": "Cantabil Ladies T-Shirt",
155              "size": "XL/CH 1.01M"
156            }
157          ],
158          "entity_type": "bag",
159          "item": {
160            "can_return": true,
161            "l3_category_name": "Others level 3",
162            "l3_category": 436,
163            "l2_category": [
164              "Others level 2"
165            ],
166            "l2_category_id": 412,
167            "l1_category": [
168              "Others"
169            ],
170            "color": null,
171            "id": 8747251,
172            "branch_url": null,
173            "code": "LTSH00038_B.GREEN",
174            "last_updated_at": "2024-03-29T09:21:02+00:00",
175            "webstore_product_url": null,
176            "l1_category_id": 406,
177            "gender": null,
178            "brand_id": 75,
179            "slug_key": "cantabil-ladies-t-shirt-aqyvd9-7lhu-8747251",
180            "name": "Cantabil Ladies T-Shirt",
181            "brand": "CANTABIL",
182            "can_cancel": true,
183            "meta": {
184              "tags": [],
185              "departments": [
186                8
187              ]
188            },
189            "attributes": {
190              "name": "Cantabil Ladies T-Shirt",
191              "color": "B.Green",
192              "essential": "No",
193              "brand_name": "CANTABIL",
194              "primary_color": "Green",
195              "primary_color_hex": "2BD892",
196              "primary-colour-hex-code": "2BD892",
197              "media": []
198            },
199            "department_id": 8,
200            "size": "XL/CH 1.01M",
201            "image": [
202              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/eVQ_yGxE69-LTSH00038_BGREEN-(1).jpg",
203              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/3lbWgByqlM-LTSH00038_BGREEN-(2).jpg",
204              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/fXYIC_EmtC-LTSH00038_BGREEN-(3).jpg",
205              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/G99OlYAKm-LTSH00038_BGREEN-(4).jpg",
206              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/hDQ9zVPYdx-LTSH00038_BGREEN-(5).jpg",
207              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/cXpjMVFRff-LTSH00038_BGREEN-(6).jpg",
208              "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/LTSH00038_BGREEN_M/wbx4WiepTi-LTSH00038_BGREEN-(7).jpg"
209            ]
210          },
211          "brand": {
212            "brand_name": "CANTABIL",
213            "modified_on": "2023-06-20T18:49:47+00:00",
214            "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/media/logo/brand/original/848_4a2906acec4c4339b31661825292c8eb.jpg",
215            "id": 75,
216            "created_on": "2016-01-04T05:15:13+00:00",
217            "is_virtual_invoice": false,
218            "credit_note_allowed": false
219          },
220          "bag_id": 33814027,
221          "article": {
222            "identifiers": {
223              "sku_code": "LTSH00038_B.GREEN_XL"
224            },
225            "esp_modified": "",
226            "size": "XL/CH 1.01M",
227            "code": "",
228            "raw_meta": null,
229            "set": {},
230            "is_set": "",
231            "seller_identifier": "LTSH00038_B.GREEN_XL",
232            "return_config": {
233              "time": 7,
234              "unit": "days",
235              "returnable": true
236            },
237            "_id": "65ee342bbc93d4f9b3c1be8d",
238            "uid": "65ee342bbc93d4f9b3c1be8d",
239            "child_details": {},
240            "dimensions": {},
241            "weight": {},
242            "currency": {},
243            "expiration_date": null
244          },
245          "current_operational_status": {
246            "status": "ready_for_dp_assignment",
247            "created_ts": "2024-03-29T12:40:47Z",
248            "delivery_partner_id": null,
249            "kafka_sync": false,
250            "bag_id": 33814027,
251            "store_id": 21209,
252            "updated_ts": "2024-03-29T12:40:47Z",
253            "id": 216538704,
254            "created_at": "2024-03-29T18:10:48+00:00",
255            "state_id": 113,
256            "state_type": "operational",
257            "shipment_id": "17116842623541524113",
258            "delivery_awb_number": null,
259            "updated_at": "2024-03-29T18:10:48+00:00",
260            "bag_state_mapper": {
261              "journey_type": "forward",
262              "app_display_name": "Ready For Dp Assignment",
263              "state_type": "operational",
264              "app_state_name": "ready_for_dp_assignment",
265              "name": "ready_for_dp_assignment",
266              "app_facing": false,
267              "id": 113,
268              "display_name": "Ready For Dp Assignment",
269              "notify_customer": false,
270              "is_active": true
271            },
272            "reasons": [],
273            "action_user": {}
274          },
275          "affiliate_bag_details": {
276            "affiliate_bag_id": "111111",
277            "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
278            "affiliate_meta": {
279              "fynd": {
280                "fulfilment_identifier": "pulse",
281                "fulfilment_identifiers_list": [
282                  "pulse"
283                ]
284              },
285              "channel_shipment_id": null,
286              "channel_order_id": null,
287              "due_date": null,
288              "is_priority": false,
289              "box_type": null,
290              "coupon_code": null,
291              "affiliate_sku": "LTSH00038_B.GREEN_XL",
292              "is_serial_number_required": true,
293              "size_level_total_qty": null,
294              "loyalty_discount": 0,
295              "employee_discount": 0
296            },
297            "loyalty_discount": 0,
298            "employee_discount": 0
299          },
300          "payment_methods": {
301            "PP": {
302              "amount": 399
303            }
304          },
305          "quantity": 1,
306          "prices": {
307            "price_effective": 399,
308            "discount": 600,
309            "amount_paid": 399,
310            "coupon_effective_discount": 0,
311            "delivery_charge": 0,
312            "fynd_credits": 0,
313            "cod_charges": 0,
314            "refund_credit": 0,
315            "cashback": 0,
316            "refund_amount": 399,
317            "added_to_fynd_cash": false,
318            "cashback_applied": 0,
319            "gst_tax_percentage": 5,
320            "value_of_good": 380,
321            "price_marked": 999,
322            "transfer_price": 0,
323            "brand_calculated_amount": 399,
324            "tax_collected_at_source": 0,
325            "tcs_percentage": 0,
326            "promotion_effective_discount": 0,
327            "gift_price": 0,
328            "coupon_value": 0,
329            "seller_promotion_effective_discount": 0,
330            "fynd_promotion_effective_discount": 0,
331            "amount_paid_roundoff": 399
332          },
333          "order_created": "2024-03-29T09:21:02+00:00",
334          "gst_details": {
335            "gstin_code": "09AAACK3901B1Z4",
336            "gst_tag": "IGST",
337            "hsn_code": "61099010",
338            "value_of_good": 380,
339            "gst_tax_percentage": 5,
340            "is_default_hsn_code": false,
341            "brand_calculated_amount": 399,
342            "tax_collected_at_source": 0,
343            "hsn_code_id": "627783855e4c6fdbc8be3f70",
344            "gst_fee": 19,
345            "igst_tax_percentage": 5,
346            "sgst_tax_percentage": 0,
347            "cgst_tax_percentage": 0,
348            "igst_gst_fee": 19,
349            "cgst_gst_fee": "0",
350            "sgst_gst_fee": "0"
351          },
352          "line_number": 1,
353          "applied_promos": [],
354          "meta": {
355            "charges": [
356              {
357                "name": "amount_paid",
358                "type": "amount_paid",
359                "amount": {
360                  "value": 399,
361                  "currency": "INR"
362                }
363              },
364              {
365                "name": "price_effective",
366                "type": "price_effective",
367                "amount": {
368                  "value": 399,
369                  "currency": "INR"
370                }
371              },
372              {
373                "name": "price_marked",
374                "type": "price_marked",
375                "amount": {
376                  "value": 999,
377                  "currency": "INR"
378                }
379              },
380              {
381                "name": "mrp",
382                "type": "mrp",
383                "amount": {
384                  "value": 999,
385                  "currency": "INR"
386                }
387              },
388              {
389                "name": "unit_price",
390                "type": "unit_price",
391                "amount": {
392                  "value": 399,
393                  "currency": "INR"
394                }
395              },
396              {
397                "name": "delivery_charge",
398                "type": "delivery_charge",
399                "amount": {
400                  "value": 0,
401                  "currency": "INR"
402                }
403              },
404              {
405                "name": "discount",
406                "type": "discount",
407                "amount": {
408                  "value": 600,
409                  "currency": "INR"
410                }
411              }
412            ],
413            "group_id": "",
414            "gift_card": {},
415            "tag_number": [
416              "MP29513922"
417            ],
418            "docket_number": "171168426235415241131",
419            "affiliate_meta": {
420              "affiliate_sku": "LTSH00038_B.GREEN_XL",
421              "is_serial_number_required": true
422            },
423            "partial_can_ret": false,
424            "parent_docket_number": "171168426235415241131",
425            "delivery_charges_hsn_code": "996819",
426            "multi_quantity_bag_enabled": false
427          }
428        }
429      ],
430      "bag_status_history": [
431        {
432          "status": "pending",
433          "created_ts": "2024-03-29T03:51:02Z",
434          "delivery_partner_id": null,
435          "kafka_sync": false,
436          "bag_id": 33814027,
437          "store_id": 21209,
438          "updated_ts": "2024-03-29T03:51:02Z",
439          "id": 216405514,
440          "created_at": "2024-03-29T09:21:02+00:00",
441          "state_id": 89,
442          "state_type": "operational",
443          "shipment_id": "17116842623541524113",
444          "delivery_awb_number": null,
445          "updated_at": "2024-03-29T09:21:02+00:00",
446          "bag_state_mapper": {
447            "journey_type": "forward",
448            "app_display_name": "Pending",
449            "state_type": "operational",
450            "app_state_name": "pending",
451            "name": "pending",
452            "app_facing": true,
453            "id": 89,
454            "display_name": "Pending",
455            "notify_customer": true,
456            "is_active": true
457          },
458          "reasons": [],
459          "action_user": {}
460        },
461        {
462          "status": "placed",
463          "created_ts": "2024-03-29T03:51:02Z",
464          "delivery_partner_id": null,
465          "kafka_sync": false,
466          "bag_id": 33814027,
467          "store_id": 21209,
468          "updated_ts": "2024-03-29T03:51:02Z",
469          "id": 216405515,
470          "created_at": "2024-03-29T09:21:03+00:00",
471          "state_id": 1,
472          "state_type": "operational",
473          "shipment_id": "17116842623541524113",
474          "delivery_awb_number": null,
475          "updated_at": "2024-03-29T09:21:03+00:00",
476          "bag_state_mapper": {
477            "journey_type": "forward",
478            "app_display_name": "Processing",
479            "state_type": "operational",
480            "app_state_name": "processing",
481            "name": "placed",
482            "app_facing": true,
483            "id": 1,
484            "display_name": "Placed",
485            "notify_customer": true,
486            "is_active": true
487          },
488          "reasons": [],
489          "action_user": {}
490        },
491        {
492          "status": "bag_confirmed",
493          "created_ts": "2024-03-29T12:30:59Z",
494          "delivery_partner_id": null,
495          "kafka_sync": false,
496          "bag_id": 33814027,
497          "store_id": 21209,
498          "updated_ts": "2024-03-29T12:30:59Z",
499          "id": 216536772,
500          "created_at": "2024-03-29T18:01:00+00:00",
501          "state_id": 2,
502          "state_type": "operational",
503          "shipment_id": "17116842623541524113",
504          "delivery_awb_number": null,
505          "updated_at": "2024-03-29T18:01:00+00:00",
506          "bag_state_mapper": {
507            "journey_type": "forward",
508            "app_display_name": "Confirmed",
509            "state_type": "operational",
510            "app_state_name": "confirmed",
511            "name": "bag_confirmed",
512            "app_facing": true,
513            "id": 2,
514            "display_name": "Confirmed",
515            "notify_customer": false,
516            "is_active": true
517          },
518          "reasons": [],
519          "action_user": {}
520        },
521        {
522          "status": "bag_invoiced",
523          "created_ts": "2024-03-29T12:40:47Z",
524          "delivery_partner_id": null,
525          "kafka_sync": false,
526          "bag_id": 33814027,
527          "store_id": 21209,
528          "updated_ts": "2024-03-29T12:40:47Z",
529          "id": 216538701,
530          "created_at": "2024-03-29T18:10:48+00:00",
531          "state_id": 91,
532          "state_type": "operational",
533          "shipment_id": "17116842623541524113",
534          "delivery_awb_number": null,
535          "updated_at": "2024-03-29T18:10:48+00:00",
536          "bag_state_mapper": {
537            "journey_type": "forward",
538            "app_display_name": "Bag Invoiced",
539            "state_type": "operational",
540            "app_state_name": "bag_invoiced",
541            "name": "bag_invoiced",
542            "app_facing": false,
543            "id": 91,
544            "display_name": "Bag Invoiced",
545            "notify_customer": false,
546            "is_active": true
547          },
548          "reasons": [],
549          "action_user": {
550            "title": "Staff",
551            "user_id": "23546902",
552            "user_name": "65a113b057cb98b50c75f344",
553            "order_role": "full_access",
554            "employee_code": ""
555          }
556        },
557        {
558          "status": "ready_for_dp_assignment",
559          "created_ts": "2024-03-29T12:40:47Z",
560          "delivery_partner_id": null,
561          "kafka_sync": false,
562          "bag_id": 33814027,
563          "store_id": 21209,
564          "updated_ts": "2024-03-29T12:40:47Z",
565          "id": 216538704,
566          "created_at": "2024-03-29T18:10:48+00:00",
567          "state_id": 113,
568          "state_type": "operational",
569          "shipment_id": "17116842623541524113",
570          "delivery_awb_number": null,
571          "updated_at": "2024-03-29T18:10:48+00:00",
572          "bag_state_mapper": {
573            "journey_type": "forward",
574            "app_display_name": "Ready For Dp Assignment",
575            "state_type": "operational",
576            "app_state_name": "ready_for_dp_assignment",
577            "name": "ready_for_dp_assignment",
578            "app_facing": false,
579            "id": 113,
580            "display_name": "Ready For Dp Assignment",
581            "notify_customer": false,
582            "is_active": true
583          },
584          "reasons": [],
585          "action_user": {}
586        }
587      ],
588      "fulfilling_store": {
589        "id": 21209,
590        "code": "V5",
591        "name": "Cantabil Retail India Limited",
592        "address": "test address",
593        "state": "Uttar Pradesh",
594        "city": "Lucknow",
595        "pincode": "1111",
596        "country": "India",
597        "phone": "1111111111",
598        "meta": {
599          "timing": [
600            {
601              "weekday": "monday",
602              "opening": {
603                "hour": 11,
604                "minute": 0
605              },
606              "closing": {
607                "hour": 22,
608                "minute": 0
609              },
610              "open": true
611            },
612            {
613              "weekday": "tuesday",
614              "opening": {
615                "hour": 11,
616                "minute": 0
617              },
618              "closing": {
619                "hour": 22,
620                "minute": 0
621              },
622              "open": true
623            },
624            {
625              "weekday": "wednesday",
626              "opening": {
627                "hour": 11,
628                "minute": 0
629              },
630              "closing": {
631                "hour": 22,
632                "minute": 0
633              },
634              "open": true
635            },
636            {
637              "weekday": "thursday",
638              "opening": {
639                "hour": 11,
640                "minute": 0
641              },
642              "closing": {
643                "hour": 22,
644                "minute": 0
645              },
646              "open": true
647            },
648            {
649              "weekday": "friday",
650              "opening": {
651                "hour": 11,
652                "minute": 0
653              },
654              "closing": {
655                "hour": 22,
656                "minute": 0
657              },
658              "open": true
659            },
660            {
661              "weekday": "saturday",
662              "opening": {
663                "hour": 11,
664                "minute": 0
665              },
666              "closing": {
667                "hour": 22,
668                "minute": 0
669              },
670              "open": true
671            },
672            {
673              "weekday": "sunday",
674              "opening": {
675                "hour": 11,
676                "minute": 0
677              },
678              "closing": {
679                "hour": 22,
680                "minute": 0
681              },
682              "open": true
683            }
684          ],
685          "stage": null,
686          "display_name": "Cantabil Retail India Limited",
687          "notification_emails": [
688            "test@example.com"
689          ],
690          "product_return_config": {
691            "on_same_store": false,
692            "store_uid": 14396
693          },
694          "gst_credentials": {
695            "e_invoice": {
696              "enabled": false
697            },
698            "e_waybill": {
699              "enabled": false
700            }
701          },
702          "gst_number": "111111",
703          "additional_contact_details": {
704            "number": [
705              "91 - 111111",
706              "91 - 111111"
707            ]
708          },
709          "documents": {
710            "gst": {
711              "type": "gst",
712              "value": "09AAACK3901B1Z4",
713              "url": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/2411/stores/all/legal/documents/free/original/oAtgkjxi4-09-UP-Certificate.pdf",
714              "verified": true,
715              "legal_name": "Cantabil Retail India Limited"
716            }
717          },
718          "auto_invoice": false,
719          "credit_note": false,
720          "ewaybill_portal_details": null
721        },
722        "fulfillment_channel": "pulse",
723        "location_type": "high_street",
724        "company_id": 2411,
725        "is_active": false,
726        "tags": []
727      },
728      "prices": {
729        "amount_paid": 399,
730        "refund_amount": 399,
731        "price_marked": 999,
732        "cod_charges": 0,
733        "discount": 600,
734        "cashback_applied": 0,
735        "delivery_charge": 0,
736        "fynd_credits": 0,
737        "cashback": 0,
738        "price_effective": 399,
739        "refund_credit": 0,
740        "value_of_good": 380,
741        "coupon_value": 0,
742        "tax_collected_at_source": 0,
743        "promotion_effective_discount": 0,
744        "fynd_promotion_effective_discount": 0,
745        "seller_promotion_effective_discount": 0,
746        "cn_refund_amount": 0,
747        "gift_price": 0,
748        "amount_paid_roundoff": 399
749      },
750      "payments": {
751        "id": 8,
752        "mode": "PP",
753        "logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/payment/default_card.png",
754        "display_name": "on",
755        "display_priority": 7,
756        "source": "PartnerPay",
757        "is_active": false
758      },
759      "affiliate_details": {
760        "id": "618a224ce93512680cfd93d0",
761        "affiliate_bag_id": "1847041749",
762        "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
763        "company_affiliate_tag": "MYNTRA_IN",
764        "affiliate_id": "618a224ce93512680cfd93d0",
765        "affiliate_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
766        "shipment_meta": {
767          "sla": null,
768          "weight": 500,
769          "due_date": "2024-03-31 16:00:00",
770          "external": {},
771          "vertical": "NA",
772          "lock_data": {
773            "mto": false,
774            "locked": false,
775            "lock_message": "Shipment locked as per application config"
776          },
777          "bag_weight": {
778            "33814027": 500
779          },
780          "debug_info": {
781            "stormbreaker_uuid": ""
782          },
783          "dp_options": {},
784          "order_type": "HomeDelivery",
785          "dp_sort_key": null,
786          "is_self_ship": false,
787          "delivery_slots": {},
788          "courier_partners": [],
789          "fulfillment_tags": [],
790          "is_international": false,
791          "processing_dates": {
792            "pack_by_date": "31-03-2024 16:00:00",
793            "confirm_by_date": "29-03-2024 09:20:57"
794          },
795          "is_export_shipment": false,
796          "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
797          "same_store_available": true,
798          "fulfill_virtual_invoice": false,
799          "618a224ce93512680cfd93d0": {
800            "merchant_id": "AAASELEL",
801            "payment_method": "PP",
802            "x_partner_store": "myntra",
803            "marketplace_store_id": "V5",
804            "processing_start_time": "29-03-2024 09:20:57"
805          },
806          "fulfilment_priority_text": null,
807          "store_invoice_updated_ts": "2024-03-29T12:40:47Z",
808          "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",
809          "E-invoice_applicable_response": {
810            "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
811            "is_applicable": false
812          },
813          "auto_trigger_dp_assignment_ACF": true,
814          "eligible_for_split": false
815        },
816        "affiliate_meta": {
817          "fynd": {
818            "fulfilment_identifier": "pulse",
819            "fulfilment_identifiers_list": [
820              "pulse"
821            ]
822          },
823          "channel_shipment_id": null,
824          "channel_order_id": null,
825          "due_date": null,
826          "is_priority": false,
827          "box_type": null,
828          "coupon_code": null,
829          "affiliate_sku": "LTSH00038_B.GREEN_XL",
830          "is_serial_number_required": true,
831          "size_level_total_qty": null,
832          "loyalty_discount": 0,
833          "employee_discount": 0
834        },
835        "affiliate_store_id": "V5",
836        "pdf_links": {
837          "label_type": "external",
838          "invoice_type": "external"
839        },
840        "config": {
841          "id": "618a224ce93512680cfd93d0",
842          "meta": [
843            {
844              "name": "shipment_lock_states",
845              "value": [
846                "bag_confirmed",
847                "dp_assigned"
848              ]
849            }
850          ],
851          "name": "MYNTRA_IN",
852          "token": null,
853          "dp_assignment": false,
854          "app_company_id": 2411,
855          "article_assignment": {},
856          "force_reassignment": false,
857          "sales_channel_logo": "",
858          "ordering_channel_logo": "",
859          "post_order_reassignment": false
860        }
861      },
862      "article_details": {
863        "status": {
864          "ready_for_dp_assignment": {
865            "65ee342bbc93d4f9b3c1be8d": {
866              "uid": "65ee342bbc93d4f9b3c1be8d",
867              "_id": "65ee342bbc93d4f9b3c1be8d",
868              "is_set": "",
869              "bag_ids": [
870                {
871                  "bag_id": 33814027,
872                  "quantity": 1
873                }
874              ],
875              "quantity": 1,
876              "reasons": {}
877            }
878          }
879        }
880      },
881      "dp_details": {
882        "id": null,
883        "name": null,
884        "awb_no": null,
885        "eway_bill_id": null,
886        "track_url": null,
887        "gst_tag": "sgst",
888        "extension_id": null,
889        "scheme_id": null,
890        "courier_partner_slug": null
891      },
892      "rto_address": {
893        "location_type": "warehouse",
894        "name": "Cantabil Retail India Limited- B16",
895        "store_address_json": {
896          "version": "1.0",
897          "contact_person": "Cantabil Retail",
898          "address": "",
899          "address1": "test address",
900          "address2": "NEW DELHI",
901          "name": "Cantabil Retail",
902          "area": "",
903          "area_code": "",
904          "area_code_slug": "",
905          "landmark": "",
906          "city": "North West Delhi",
907          "state": "Delhi",
908          "country": "India",
909          "pincode": "110035",
910          "longitude": 72.8423802,
911          "sector": "",
912          "latitude": 19.0653252,
913          "phone": "1111111111",
914          "email": "test@example.com",
915          "address_type": "store",
916          "address_category": "store",
917          "created_at": "2024-03-29 18:01:00",
918          "updated_at": "2024-03-29 18:01:00",
919          "country_phone_code": null,
920          "country_iso_code": "IN",
921          "country_code": "IN",
922          "display_address": "test address"
923        },
924        "id": 14396,
925        "code": "WHCIRL",
926        "company_id": 2411,
927        "address1": "test address",
928        "address2": "NEW DELHI",
929        "display_address": "test address",
930        "city": "North West Delhi",
931        "state": "Delhi",
932        "sector": "",
933        "country": "India",
934        "pincode": "110035",
935        "store_email": "test@example.com",
936        "contact_person": "Cantabil Retail",
937        "phone": "1111111111"
938      },
939      "weight": {
940        "value": 500,
941        "unit": "gram"
942      },
943      "shipment_meta": {
944        "sla": null,
945        "weight": 500,
946        "due_date": "2024-03-31 16:00:00",
947        "external": {},
948        "vertical": "NA",
949        "lock_data": {
950          "mto": false,
951          "locked": false,
952          "lock_message": "Shipment locked as per application config"
953        },
954        "bag_weight": {
955          "33814027": 500
956        },
957        "debug_info": {
958          "stormbreaker_uuid": ""
959        },
960        "dp_options": {},
961        "order_type": "HomeDelivery",
962        "dp_sort_key": null,
963        "is_self_ship": false,
964        "delivery_slots": {},
965        "courier_partners": [],
966        "fulfillment_tags": [],
967        "is_international": false,
968        "processing_dates": {
969          "pack_by_date": "31-03-2024 16:00:00",
970          "confirm_by_date": "29-03-2024 09:20:57"
971        },
972        "is_export_shipment": false,
973        "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
974        "same_store_available": true,
975        "fulfill_virtual_invoice": false,
976        "618a224ce93512680cfd93d0": {
977          "merchant_id": "AAASELEL",
978          "payment_method": "PP",
979          "x_partner_store": "myntra",
980          "marketplace_store_id": "V5",
981          "processing_start_time": "29-03-2024 09:20:57"
982        },
983        "fulfilment_priority_text": null,
984        "store_invoice_updated_ts": "2024-03-29T12:40:47Z",
985        "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",
986        "E-invoice_applicable_response": {
987          "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
988          "is_applicable": false
989        },
990        "auto_trigger_dp_assignment_ACF": true,
991        "eligible_for_split": false
992      },
993      "shipment_gst": {
994        "value_of_good": 380,
995        "gst_fee": 19,
996        "brand_calculated_amount": 399,
997        "tax_collected_at_source": 0,
998        "gstin_code": "09AAACK3901B1Z4"
999      },
1000      "store_invoice_id": "V50324-02266",
1001      "credit_note_id": "",
1002      "order_created": "2024-03-29T09:21:02+00:00",
1003      "payment_methods": {
1004        "PP": {
1005          "amount": 399,
1006          "mode": "PP",
1007          "name": "on",
1008          "collect_by": "seller",
1009          "refund_by": "seller",
1010          "meta": {
1011            "payment_id": null
1012          }
1013        }
1014      },
1015      "payment_info": [],
1016      "order": {
1017        "ordering_channel": "MARKETPLACE",
1018        "ordering_source": "marketplace",
1019        "affiliate_order_date": "2024-03-29T09:21:02+00:00",
1020        "affiliate_order_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
1021        "fynd_order_id": "FYMP66063AA601BFA6A8",
1022        "mode_of_payment": "FY_MYNTRA",
1023        "source": "NA",
1024        "total_order_value": 399,
1025        "collect_by": "seller",
1026        "refund_by": "seller",
1027        "order_value": 399,
1028        "meta": {
1029          "staff": {},
1030          "charges": [
1031            {
1032              "name": "order",
1033              "type": "amount_paid",
1034              "amount": {
1035                "value": 399,
1036                "currency": "INR"
1037              }
1038            },
1039            {
1040              "name": "order",
1041              "type": "order_value",
1042              "amount": {
1043                "value": 399,
1044                "currency": "INR"
1045              }
1046            },
1047            {
1048              "code": "",
1049              "name": "COD Charges",
1050              "type": "cod_charges",
1051              "amount": {
1052                "value": 0,
1053                "currency": "INR"
1054              }
1055            },
1056            {
1057              "code": "",
1058              "name": "Delivery Charges",
1059              "type": "delivery_charges",
1060              "amount": {
1061                "value": 0,
1062                "currency": "INR"
1063              }
1064            }
1065          ],
1066          "currency": {
1067            "currency_code": "INR",
1068            "currency_name": "Indian Rupee",
1069            "currency_symbol": "₹",
1070            "currency_sub_unit": "Paisa"
1071          },
1072          "extra_meta": {},
1073          "order_type": "NEW",
1074          "employee_id": "",
1075          "company_logo": null,
1076          "payment_type": null,
1077          "currency_info": {
1078            "order_currency": "INR",
1079            "conversion_rate": {}
1080          },
1081          "mongo_cart_id": 1000000007,
1082          "ordering_store": null,
1083          "seller_details": {},
1084          "conversion_rate": {
1085            "base": "INR",
1086            "rates": {
1087              "INR": {
1088                "name": "Indian Rupee",
1089                "value": 1,
1090                "symbol": "₹",
1091                "sub_unit": "Paisa"
1092              }
1093            },
1094            "timestamp": 1710958051.738545
1095          },
1096          "sales_channel_logo": "",
1097          "order_child_entities": [
1098            "shipment",
1099            "bag"
1100          ],
1101          "billing_staff_details": {},
1102          "ordering_channel_logo": "",
1103          "platform_user_details": {},
1104          "external_creation_date": "29-03-2024 09:20:33",
1105          "order_tags": []
1106        }
1107      },
1108      "order_source": "NA",
1109      "journey_type": "forward",
1110      "einvoice_info": {},
1111      "lock_status": false,
1112      "original_bag_list": [
1113        33814027
1114      ],
1115      "shipment_update_time": 1711716047.9110363,
1116      "transaction_meta": {},
1117      "meta": {
1118        "sla": null,
1119        "weight": 500,
1120        "due_date": "2024-03-31 16:00:00",
1121        "external": {},
1122        "vertical": "NA",
1123        "lock_data": {
1124          "mto": false,
1125          "locked": false,
1126          "lock_message": "Shipment locked as per application config"
1127        },
1128        "bag_weight": {
1129          "33814027": 500
1130        },
1131        "debug_info": {
1132          "stormbreaker_uuid": ""
1133        },
1134        "dp_options": {},
1135        "order_type": "HomeDelivery",
1136        "dp_sort_key": null,
1137        "is_self_ship": false,
1138        "delivery_slots": {},
1139        "courier_partners": [],
1140        "fulfillment_tags": [],
1141        "is_international": false,
1142        "processing_dates": {
1143          "pack_by_date": "31-03-2024 16:00:00",
1144          "confirm_by_date": "29-03-2024 09:20:57"
1145        },
1146        "is_export_shipment": false,
1147        "channel_shipment_id": "b8ea4770-1a1c-43fc-8967-c3724b69b461",
1148        "same_store_available": true,
1149        "fulfill_virtual_invoice": false,
1150        "618a224ce93512680cfd93d0": {
1151          "merchant_id": "AAASELEL",
1152          "payment_method": "PP",
1153          "x_partner_store": "myntra",
1154          "marketplace_store_id": "V5",
1155          "processing_start_time": "29-03-2024 09:20:57"
1156        },
1157        "fulfilment_priority_text": null,
1158        "store_invoice_updated_ts": "2024-03-29T12:40:47Z",
1159        "store_invoice_updated_date": "2024-03-29T18:10:47+00:00",
1160        "E-invoice_applicable_response": {
1161          "message": "Shipment is not applicable for E-invoice generation as buyer GSTIN not present",
1162          "is_applicable": false
1163        },
1164        "auto_trigger_dp_assignment_ACF": true,
1165        "eligible_for_split": false
1166      },
1167      "previous_shipment_id": null,
1168      "fyndstore_emp": {},
1169      "ordering_store": {},
1170      "coupon": {},
1171      "cart_info": {
1172        "cart_id": "",
1173        "cart_uid": 1000000007
1174      }
1175    }
1176  }
1177}

Sort configuration

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

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

application/sort/create/v1

this event is triggered when sort 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
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "sort",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260100414,
10    "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "id": "660f03f6b83b58237cc2e8de",
25      "is_active": true,
26      "key": "latest",
27      "name": "Wilfredo338053264320241948250",
28      "is_default": true,
29      "priority": 2,
30      "default_key": "latest",
31      "logo": "/addsale/misc/default-assets/original/latest-products.png",
32      "app_id": "660edfcaaaaa57fb0b439b31"
33    }
34  }
35}

application/sort/delete/v1

this event is triggered when sort 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
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "sort",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "name": "Latest Products",
25      "is_default": true,
26      "key": "latest",
27      "is_active": true,
28      "default_key": "popular",
29      "priority": 1,
30      "logo": "/addsale/misc/default-assets/original/latest-products.png",
31      "app_id": "660edfcaaaaa57fb0b439b31",
32      "id": "660f03f243ec2f1db3288646"
33    }
34  }
35}

application/sort/update/v1

this event is triggered when sort 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
sort
object
Required
Properties
id
string
Required
UUID of the sort config.
key
string
Required
Slug of the sort attribute.
logo
string
Logo to show for the sort in the configuration.
name
string
Required
Display Name of the Sort config.
app_id
string
Required
Unique ID of the application.
priority
integer
Required
Position of the Sort config.
is_active
boolean
Required
Active status of the sort config.
is_default
boolean
Required
Default sorting values from the system.
default_key
string
Required
The default sort key
display_name
string
Name to be displayed on the storefront in the sorting options.
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        "sort"
78      ],
79      "properties": {
80        "sort": {
81          "type": "object",
82          "required": [
83            "app_id",
84            "id",
85            "key",
86            "is_active",
87            "priority",
88            "is_default",
89            "default_key",
90            "name"
91          ],
92          "properties": {
93            "id": {
94              "type": "string",
95              "description": "UUID of the sort config."
96            },
97            "key": {
98              "type": "string",
99              "description": "Slug of the sort attribute."
100            },
101            "logo": {
102              "type": "string",
103              "description": "Logo to show for the sort in the configuration."
104            },
105            "name": {
106              "type": "string",
107              "description": "Display Name of the Sort config."
108            },
109            "app_id": {
110              "type": "string",
111              "description": "Unique ID of the application."
112            },
113            "priority": {
114              "type": "integer",
115              "description": "Position of the Sort config."
116            },
117            "is_active": {
118              "type": "boolean",
119              "description": "Active status of the sort config."
120            },
121            "is_default": {
122              "type": "boolean",
123              "description": "Default sorting values from the system."
124            },
125            "default_key": {
126              "type": "string",
127              "description": "The default sort key"
128            },
129            "display_name": {
130              "type": "string",
131              "description": "Name to be displayed on the storefront in the sorting options."
132            }
133          },
134          "description": ""
135        }
136      }
137    }
138  }
139}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.49fcd33c-f2bc-11ee-9e0b-3ad0e80209a5"
5    ],
6    "name": "sort",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260100414,
10    "id": "HCkLSRxDLcW/5viadcRKFRJtOyxjcKqwcNxmYgFGCLI=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31",
17    "*"
18  ],
19  "contains": [
20    "sort"
21  ],
22  "payload": {
23    "sort": {
24      "id": "660f03f6b83b58237cc2e8de",
25      "is_active": true,
26      "key": "latest",
27      "name": "Wilfredo338053264320241948250",
28      "is_default": true,
29      "priority": 2,
30      "default_key": "latest",
31      "logo": "/addsale/misc/default-assets/original/latest-products.png",
32      "app_id": "660edfcaaaaa57fb0b439b31"
33    }
34  }
35}

Tags

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

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

application/tags/create/v1

this event is triggered when tag 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
tags
object
Required
Properties
__v
integer
Required
_id
string
Required
tags
array of object
Required
List of tags (either CSS/JS) that will be injected into website's HTML
Array of Properties
_id
string
name
string
Name given to the tag
type
string
Required
Type of Tag - whether it is CSS or JavaScript
content
string
position
string
Required
Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom
sub_type
string
Required
Tag is external or inline
company
string
Required
application
string
Required
sales channel ID corresponding to the website into which the tags will be injected
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        "tags"
78      ],
79      "properties": {
80        "tags": {
81          "type": "object",
82          "required": [
83            "_id",
84            "tags",
85            "application",
86            "__v",
87            "company"
88          ],
89          "properties": {
90            "__v": {
91              "type": "integer"
92            },
93            "_id": {
94              "type": "string"
95            },
96            "tags": {
97              "type": "array",
98              "items": {
99                "type": "object",
100                "required": [
101                  "sub_type",
102                  "type",
103                  "position"
104                ],
105                "properties": {
106                  "_id": {
107                    "type": "string"
108                  },
109                  "name": {
110                    "type": "string",
111                    "description": "Name given to the tag"
112                  },
113                  "type": {
114                    "type": "string",
115                    "description": "Type of Tag - whether it is CSS or JavaScript"
116                  },
117                  "content": {
118                    "type": "string"
119                  },
120                  "position": {
121                    "type": "string",
122                    "description": "Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom"
123                  },
124                  "sub_type": {
125                    "type": "string",
126                    "description": "Tag is external or inline"
127                  }
128                }
129              },
130              "description": "List of tags (either CSS/JS) that will be injected into website's HTML"
131            },
132            "company": {
133              "type": "string"
134            },
135            "application": {
136              "type": "string",
137              "description": "sales channel ID corresponding to the website into which the tags will be injected"
138            }
139          }
140        }
141      }
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.b29bc7b6-9a60-4f5d-96b6-a9e6d129bdee"
5    ],
6    "name": "tags",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712125495190,
10    "id": "rGjRf4A2C2mkahzmomK37QWiEepFrFRkIveWaaCxMJY=",
11    "category": "application"
12  },
13  "company_id": 6811,
14  "application_id": "65c1ed4d877d97b7884b2f23",
15  "contains": [
16    "tags"
17  ],
18  "payload": {
19    "tags": {
20      "_id": "65e591f4a2bc1056c18962c7",
21      "application": "65c1ed4d877d97b7884b2f23",
22      "company": "6811",
23      "tags": [
24        {
25          "content": "let startTime = Date.now();\nfunction visenzeCallback () {\n\twindow.visenzeSearchWidget = window.visenzeWidget4447;\n\tconsole.debug('visenzeSearchWidget is initialized in ' + (Date.now() - startTime) + 'ms');\n}\n\nfunction visenzeCallbackMobile () {\n\twindow.visenzeSearchWidgetMobile = window.visenzeWidget4447;\n\tconsole.debug('visenzeSearchWidgetMobile is initialized in ' + (Date.now() - startTime) + 'ms');\n}\n\n!function(x,e,t,n,r,i,a){var o=localStorage.getItem(\"va-uid\")||function x(){let e=new Date().getTime(),t=\"xxxxxxxx.xxxx.4xxx.yxxx.xxxxxxxxxxxx\".replace(/[xy]/g,x=>{let t=(e+16*Math.random())%16|0;return e=Math.floor(e/16),(\"x\"===x?t:3&t|8).toString(16)});return t}(),c=x.getElementsByTagName(e)[0],d=x.createElement(e),g=new URL(`https://search-dev.visenze.com/v2/widget-init?app_key=${t}&placement_id=${n}&container=${r}&uid=${o}`);i&&(g+=`&contexts=${i}`),d.async=!0,d.src=g,d.onload=function(){a&&a()},c.parentNode.insertBefore(d,c)}(document,\"script\",\"e227b0969dbe12985bd62b047fdcbea2\",\"4447\",\".ps-widget-4447\", \"\", visenzeCallback);\n\n!function(x,e,t,n,r,i,a){var o=localStorage.getItem(\"va-uid\")||function x(){let e=new Date().getTime(),t=\"xxxxxxxx.xxxx.4xxx.yxxx.xxxxxxxxxxxx\".replace(/[xy]/g,x=>{let t=(e+16*Math.random())%16|0;return e=Math.floor(e/16),(\"x\"===x?t:3&t|8).toString(16)});return t}(),c=x.getElementsByTagName(e)[0],d=x.createElement(e),g=new URL(`https://search-dev.visenze.com/v2/widget-init?app_key=${t}&placement_id=${n}&container=${r}&uid=${o}`);i&&(g+=`&contexts=${i}`),d.async=!0,d.src=g,d.onload=function(){a&&a()},c.parentNode.insertBefore(d,c)}(document,\"script\",\"e227b0969dbe12985bd62b047fdcbea2\",\"4447\",\".ps-widget-4447-mobile\", \"\", visenzeCallbackMobile);\n\nwindow.addEventListener('load', function() {\n        const searchWidgetContainerDesktop = document.createElement('div');\n\t\tsearchWidgetContainerDesktop.classList.add('ps-widget-4447');\n        \n        const searchWidgetContainerMobile = document.createElement('div');\n\t\tsearchWidgetContainerMobile.classList.add('ps-widget-4447-mobile');\n            \n\t\tconst iconContainers = document.querySelectorAll('.right');\n        \n        iconContainers[0].appendChild(searchWidgetContainerDesktop);\n        iconContainers[1].appendChild(searchWidgetContainerMobile);\n           \n \t\tsetTimeout(() => {\n        \tvisenzeSearchWidget.rerender();\n            visenzeSearchWidgetMobile.rerender();\n        },  100)\n});",
26          "_id": "660397f64f419feb069eda82",
27          "name": "visenze-search-widget",
28          "type": "js",
29          "sub_type": "inline",
30          "compatible_engines": [
31            "vue2",
32            "react"
33          ],
34          "position": "body-bottom",
35          "pages": [
36            {
37              "page_slug": "about-us",
38              "type": "system"
39            }
40          ]
41        },
42        {
43          "url": "https://e711-158-140-146-52.ngrok-free.app/widget-scripts/add-to-cart.js",
44          "_id": "660cc0824803612f66e4a2cb",
45          "name": "ViSenze Add to Cart tracking script",
46          "type": "js",
47          "sub_type": "external",
48          "compatible_engines": [],
49          "position": "body-bottom",
50          "pages": [
51            {
52              "page_slug": "product",
53              "type": "system"
54            }
55          ],
56          "__source": {
57            "type": "extension",
58            "id": "65e54deed85c58b8a10696c8"
59          }
60        },
61        {
62          "url": "https://e711-158-140-146-52.ngrok-free.app/widget-scripts/transaction.js",
63          "_id": "660cc0824803612f66e4a2cc",
64          "name": "ViSenze Transaction tracking script",
65          "type": "js",
66          "sub_type": "external",
67          "compatible_engines": [],
68          "position": "body-bottom",
69          "pages": [
70            {
71              "page_slug": "order-status",
72              "type": "system"
73            }
74          ],
75          "__source": {
76            "type": "extension",
77            "id": "65e54deed85c58b8a10696c8"
78          }
79        },
80        {
81          "url": "https://e711-158-140-146-52.ngrok-free.app/widget-scripts/add-to-cart.js",
82          "_id": "660cc0a35c786cf7642da90c",
83          "name": "ViSenze Add to Cart tracking script",
84          "type": "js",
85          "sub_type": "external",
86          "compatible_engines": [],
87          "position": "body-bottom",
88          "pages": [
89            {
90              "page_slug": "product",
91              "type": "system"
92            }
93          ],
94          "__source": {
95            "type": "extension",
96            "id": "65e54deed85c58b8a10696c8"
97          }
98        },
99        {
100          "url": "https://e711-158-140-146-52.ngrok-free.app/widget-scripts/transaction.js",
101          "_id": "660cc0a35c786cf7642da90d",
102          "name": "ViSenze Transaction tracking script",
103          "type": "js",
104          "sub_type": "external",
105          "compatible_engines": [],
106          "position": "body-bottom",
107          "pages": [
108            {
109              "page_slug": "order-status",
110              "type": "system"
111            }
112          ],
113          "__source": {
114            "type": "extension",
115            "id": "65e54deed85c58b8a10696c8"
116          }
117        },
118        {
119          "content": "matches=window.location.href.match(/\\d+$/);if(matches){window.visenzeProductId=matches[0]};!function(e,t,a,n,s,r){e[s]=e[s]||[];var c=new URLSearchParams(e.location.search).get(r)||a.getItem(r),i=t.getElementsByTagName(n)[0],o=t.createElement(n),p=new URL(\"https://search-dev.visenze.com/v2/deploy-configs?app_key=24e66d09959a664193ca7a09a88eddfc\");c&&(p.searchParams.append(\"debug_id\",c),a.setItem(r,c)),o.async=!0,o.src=p,i.parentNode.insertBefore(o,i)}(window,document,localStorage,\"script\",\"visenzeLayer\",\"visenzeDebugId\");\n",
120          "_id": "660cf6375c786cf7642db71a",
121          "name": "ViSenze Recommendations Tag",
122          "type": "js",
123          "sub_type": "inline",
124          "compatible_engines": [
125            "vue2",
126            "react"
127          ],
128          "position": "head",
129          "pages": []
130        }
131      ],
132      "__v": 353
133    }
134  }
135}

application/tags/delete/v1

this event is triggered when tag 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
tags
object
Required
Properties
__v
integer
Required
_id
string
Required
tags
array of object
Required
List of tags (either CSS/JS) that will be injected into website's HTML
Array of Properties
_id
string
url
string
name
string
Name given to the tag
type
string
Required
Type of Tag - whether it is CSS or JavaScript
__source
object
Properties
id
string
Required
type
string
Required
position
string
Required
Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom
sub_type
string
Required
Tag is external or inline
company
string
Required
application
string
Required
ID of the application where the tags will be injected
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        "tags"
78      ],
79      "properties": {
80        "tags": {
81          "type": "object",
82          "required": [
83            "_id",
84            "tags",
85            "application",
86            "__v",
87            "company"
88          ],
89          "properties": {
90            "__v": {
91              "type": "integer"
92            },
93            "_id": {
94              "type": "string"
95            },
96            "tags": {
97              "type": "array",
98              "items": {
99                "type": "object",
100                "required": [
101                  "sub_type",
102                  "type",
103                  "position"
104                ],
105                "properties": {
106                  "_id": {
107                    "type": "string"
108                  },
109                  "url": {
110                    "type": "string"
111                  },
112                  "name": {
113                    "type": "string",
114                    "description": "Name given to the tag"
115                  },
116                  "type": {
117                    "type": "string",
118                    "description": "Type of Tag - whether it is CSS or JavaScript"
119                  },
120                  "__source": {
121                    "type": "object",
122                    "required": [
123                      "type",
124                      "id"
125                    ],
126                    "properties": {
127                      "id": {
128                        "type": "string"
129                      },
130                      "type": {
131                        "type": "string"
132                      }
133                    }
134                  },
135                  "position": {
136                    "type": "string",
137                    "description": "Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom"
138                  },
139                  "sub_type": {
140                    "type": "string",
141                    "description": "Tag is external or inline"
142                  }
143                }
144              },
145              "description": "List of tags (either CSS/JS) that will be injected into website's HTML"
146            },
147            "company": {
148              "type": "string"
149            },
150            "application": {
151              "type": "string",
152              "description": "ID of the application where the tags will be injected"
153            }
154          }
155        }
156      }
157    }
158  }
159}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.08534137-207d-43f6-82f2-9c9f520a0cb5"
5    ],
6    "name": "tags",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711756917053,
10    "id": "ZAvbgni3n6DoCiODbxFaQtVi98KDABAW5g+JeLpRt/I=",
11    "category": "application"
12  },
13  "company_id": 61,
14  "application_id": "5eb2e60f5de52793c06ea942",
15  "contains": [
16    "tags"
17  ],
18  "payload": {
19    "tags": {
20      "_id": "6260f08e18b4b059ec1c44ea",
21      "tags": [
22        {
23          "url": "https://meta.extensions.fynd.com/js/injector.js?APP_SLUG=mp-extension&__release=v0.0.0-000000",
24          "_id": "63fe51fb1ec4e70bdced5a69",
25          "name": "meta-dispatch-script",
26          "type": "js",
27          "sub_type": "external",
28          "compatible_engines": [],
29          "position": "body-bottom",
30          "pages": [],
31          "__source": {
32            "type": "extension",
33            "id": "63c0edae2fc3d4ceb700d520"
34          }
35        },
36        {
37          "content": "\n\t<!-- Google Tag Manager -->\n\t\t(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\n\t\tnew Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\n\t\tj=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n\t\t'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n\t\t})(window,document,'script','dataLayer',\"GTM-12389\");\n\t<!-- End Google Tag Manager -->\n\n\t// Data layer script\n\tconst listener = () => {\n\tconst FPI_EVENTS = {\n\t\t//USER\n\t\tLOG_IN: 'user.login',\n    \tLOG_OUT: 'user.logout',\n\t\t//USER\n\t\tPROFILE_UPDATE: 'user.update',\n\t\t//PLP\n\t\tPRODUCT_LIST_VIEW: 'product_list.view',\n\t\tCOLLECTION_LIST_VIEW: 'collection_list.view',\n\t\tPRODUCT_LIST_CLICK: 'product_list.click',\n\t\tPRODUCT_FILTER: 'product_list.filter',\n\t\tPRODUCT_SORT: 'product_list.sort',\n\t\t// PDP\n\t\tPRODUCT_DETAIL_PAGE_VIEW: 'product.view',\n\t\tNOTIFY_PRODUCT: 'notify.product',\n\t\tADD_TO_COMPARE: 'compare.add',\n\t\tREMOVE_FROM_COMPARE: 'compare.remove',\n\t\tADD_TO_WISHLIST: 'wishlist.add',\n\t\tREMOVE_FROM_WISHLIST: 'wishlist.remove',\n\t\t// CART\n\t\tVIEW_CART: 'cart.view',\n\t\tADD_TO_CART: 'cart.newProduct',\n\t\tREMOVE_FROM_CART: 'cart.remove',\n\t\tUPDATE_CART: 'cart.update',\n\t\t// ORDER\n\t\tORDER_CHECKOUT: 'order.checkout',\n\t\tADD_PAYMENT_INFORMATION: 'order.payment_information',\n\t\tADD_ADDRESS_INFORMATION: 'order.address_information',\n\t\tORDER_PROCESSED: 'order.processed',\n\t\tORDER_TRACKING_VIEW: 'order_tracking.view',\n\t\t// REFUND\n\t\tREFUND_SUCCESS: 'refund.success',\n\t\t// SEARCH\n\t\tSEARCH_PRODUCTS: 'search.products',\n\t\tPINCODE_SERVICEABILITY: 'pincode.serviceablility'\n\t};\n\n\tconst getGTMEventName = (event) => {\n\t\tconst GTM_EVENTS = {\n\t\t\t[FPI_EVENTS.PRODUCT_DETAIL_PAGE_VIEW]: 'view_item',\n\t\t\t[FPI_EVENTS.ADD_TO_CART]: 'add_to_cart',\n\t\t\t[FPI_EVENTS.REMOVE_FROM_CART]: 'remove_from_cart',\n\t\t\t[FPI_EVENTS.ORDER_CHECKOUT]: 'begin_checkout',\n\t\t\t[FPI_EVENTS.ORDER_PROCESSED]: 'purchase',\n\t\t\t[FPI_EVENTS.REFUND_SUCCESS]: 'refund',\n\t\t\t[FPI_EVENTS.PRODUCT_LIST_VIEW]: 'view_item_list',\n\t\t\t[FPI_EVENTS.COLLECTION_LIST_VIEW]:'view_collection',\n\t\t\t[FPI_EVENTS.ADD_TO_WISHLIST]: 'add_to_wishlist',\n\t\t\t[FPI_EVENTS.VIEW_CART]: 'view_cart',\n\t\t\t[FPI_EVENTS.SEARCH_PRODUCTS]: 'products_searched',\n\t\t\t[FPI_EVENTS.ADD_PAYMENT_INFORMATION] : 'add_payment_info',\n\t\t\t[FPI_EVENTS.ADD_ADDRESS_INFORMATION]: 'add_shipping_info',\n\t\t\t[FPI_EVENTS.LOG_IN]: 'login',\n    \t\t[FPI_EVENTS.LOG_OUT]: 'logout',\n\t\t\t[FPI_EVENTS.PROFILE_UPDATE]: 'profile_update'\n\t\t}\n\t\treturn GTM_EVENTS[event] || 'not_known'\n\t}\n\tconst transformData = (event, eventData) => {\n\t\tlet payload = {}\n\t\tswitch (event) {\n\t\t\tcase FPI_EVENTS.SEARCH_PRODUCTS: {\n\t\t\t\tconst { search_text } = eventData;\n\t\t\t\tpayload = {\n\t\t\t\t\t'query': search_text\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.LOG_IN: {\n\t\t\t\tconst { user_id, login_value, method, gender, phone_number, email } = eventData;\n\t\t\t\tpayload = {\n\t\t\t\t\t'user_id': user_id,\n\t\t\t\t\t'login_value': login_value,\n\t\t\t\t\t'method': method,\n\t\t\t\t\t'gender': gender,\n\t\t\t\t\t'email': email,\n\t\t\t\t\t'phone_number': phone_number\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.LOG_OUT: {\n\t\t\t\tconst { user_id, phone, email } = eventData;\n\t\t\t\tpayload = {\n\t\t\t\t\t'user_id': user_id,\n\t\t\t\t\t'phone': phone,\n\t\t\t\t\t'email': email\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.PROFILE_UPDATE: {\n\t\t\t\tconst { gender, email, phone_number, user_id} = eventData;\n\t\t\t\tpayload = {\n\t\t\t\t\t'user_id': user_id,\n\t\t\t\t\t'gender': gender,\n\t\t\t\t\t'email': email,\n\t\t\t\t\t'phone_number': phone_number\n\t\t\t\t}\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ADD_TO_WISHLIST: {\n\t\t\t\tconst { item } = eventData;\n\t\t\t\tlet item_category = \"\"\n\t\t\t\tif(item.categories && item.categories.length) {\n\t\t\t\t\titem_category = item.categories[0].name\n\t\t\t\t}\n\t\t\t\tpayload.items = [{\n\t\t\t\t\t'item_id': item.uid,\n\t\t\t\t\t'item_name': item.name,\n\t\t\t\t\t'currency': \"INR\",\n\t\t\t\t\t'discount': item.discount,\n\t\t\t\t\t'item_brand': item.brand? item.brand.name : '',\n\t\t\t\t\titem_category,\n\t\t\t\t\t'price': item.price ? item.price.effective.max : '',\n\t\t\t\t\t'quantity': 1\n\t\t\t\t}];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.REMOVE_FROM_WISHLIST: {\n\t\t\t\tconst { item } = eventData;\n\t\t\t\tlet item_category = \"\"\n\t\t\t\tif(item.categories && item.categories.length) {\n\t\t\t\t\titem_category = item.categories[0].name\n\t\t\t\t}\n\t\t\t\tpayload.items = [{\n\t\t\t\t\t'item_id': item.uid,\n\t\t\t\t\t'item_name': item.name,\n\t\t\t\t\t'currency': \"INR\",\n\t\t\t\t\t'discount': item.discount,\n\t\t\t\t\t'item_brand': item.brand.name,\n\t\t\t\t\titem_category,\n\t\t\t\t\t'price': item.price && item.price.effective.max,\n\t\t\t\t\t'quantity': 1\n\t\t\t\t}];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.PRODUCT_DETAIL_PAGE_VIEW: {\n\t\t\t\tconst { product } = eventData;\n\t\t\t\tpayload.items = [{\n\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t'item_category': product.category.name,\n\t\t\t\t\t'price': product.price.max,\n\t\t\t\t\t'quantity': 1,\n\t\t\t\t\t'currency': 'INR'\n\t\t\t\t}]\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.PRODUCT_LIST_VIEW: {\n\t\t\t\tconst {items} = eventData;\n\t\t\t\tconst itemsOfListing = [];\n\t\t\t\titems.forEach(item => {\n\t\t\t\t\tlet item_category = \"\"\n\t\t\t\t\tif(item.categories && item.categories.length) {\n\t\t\t\t\t\titem_category = item.categories[0].name\n\t\t\t\t\t}\n\t\t\t\t\tlet objectToBePushed = {\n\t\t\t\t\t\t'item_id': item.item_code ? item.item_code : '',\n\t\t\t\t\t\t'item_name': item.name ? item.name : '',\n\t\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t\t'discount': item.discount ? item.discount : '',\n\t\t\t\t\t\t'item_brand': item.brand.name ? item.brand.name : '',\n\t\t\t\t\t\t'price': item.price.effective.max ? item.price.effective.max : '',\n\t\t\t\t\t\t'quantity': 1,\n\t\t\t\t\t\t'item_list_name': eventData.name || 'Product Listing',\n\t\t\t\t\t\t'item_list_id': eventData.slug || eventData.url || 'listing_page',\n\t\t\t\t\t\t'item_uid': item.uid ? item.uid : '',\n\t\t\t\t\t\titem_category\n\t\t\t\t\t};\n\t\t\t\t\titemsOfListing.push(objectToBePushed);\n\t\t\t\t})\n\t\t\t\tpayload.item_list_name = eventData.name || 'Product Listing';\n\t\t\t\tpayload.item_list_id =  eventData.slug || eventData.url || 'listing_page';\n\t\t\t\tpayload.items = itemsOfListing;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.COLLECTION_LIST_VIEW: {\n\t\t\t\tpayload.items = [\n\t\t\t\t\t{\n\t\t\t\t\t\titem_list_name: eventData.name || 'Product Listing',\n       \t\t\t\t\titem_list_id: eventData.slug || eventData.url || 'listing_page'\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ADD_TO_CART: {\n\t\t\t\tconst {cart_id, products} = eventData;\n\t\t\t\tlet itemsToBePushed = [];\n\t\t\t\tproducts.forEach(product => itemsToBePushed.push({\n\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t'price': product.price.effective,\n\t\t\t\t\t'quantity': product.quantity.current,\n\t\t\t\t\t'item_category': product.category.name\n\t\t\t\t}))\n\t\t\t\tpayload.items = itemsToBePushed;\n\t\t\t\tpayload.cart_id = cart_id;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ORDER_CHECKOUT: {\n\t\t\t\tconst { products, cart_id, breakup_values } = eventData;\n\t\t\t\tconst itemsOfBag = [];\n\t\t\t\tproducts.forEach(product => {\n\t\t\t\t\tlet objectToBePushed = {\n\t\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t\t'discount': product.discount,\n\t\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t\t'price': product.price ? product.price.effective : '',\n\t\t\t\t\t\t'quantity': product.quantity.current,\n\t\t\t\t\t\t'item_category': product.category.name\n\t\t\t\t\t};\n\t\t\t\t\titemsOfBag.push(objectToBePushed);\n\t\t\t\t})\n\t\t\t\tpayload.value = breakup_values.raw.subtotal\n\t\t\t\tpayload.cart_id = cart_id;\n\t\t\t\tpayload.items = itemsOfBag;\n\t\t\t\tpayload.coupon = breakup_values.raw.coupon;\n\t\t\t\tpayload.coupon_code = breakup_values.coupon.code;\n\t\t\t\tpayload.shipping = breakup_values.raw.delivery_charge;\n\t\t\t\tpayload.discount = breakup_values.raw.discount;\n\t\t\t\tpayload.currency = 'INR';\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ADD_PAYMENT_INFORMATION: {\n\t\t\t\tconst payment_information = eventData;\n\t\t\t\tpayload.currency = \"INR\";\n\t\t\t\tpayload.value =  payment_information.value;\n\t\t\t\tpayload.coupon =  payment_information.coupon.coupon_code;\n\t\t\t\tpayload.payment_type = payment_information.payment.payment_type;\n\t\t\t\tpayload.shipping = payment_information.delivery_charges;\n\t\t\t\tpayload.cart_id = payment_information.cart.cart_id;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ADD_ADDRESS_INFORMATION: {\n\t\t\t\tconst payment_information = eventData;\n\t\t\t\tpayload.currency = \"INR\";\n\t\t\t\tpayload.value =  payment_information.value;\n\t\t\t\tpayload.coupon =  payment_information.coupon.coupon_code;\n\t\t\t\tpayload.pincode = payment_information.pincode;\n\t\t\t\tpayload.cart_id = payment_information.cart.cart_id;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.REMOVE_FROM_CART: {\n\t\t\t\tconst {cart_id, products} = eventData;\n\t\t\t\tlet itemsToBePushed = [];\n\t\t\t\tproducts.forEach(product => itemsToBePushed.push({\n\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t'discount': product.discount,\n\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t'price': product.price ? product.price.effective : '',\n\t\t\t\t\t'quantity': product.quantity.current,\n\t\t\t\t\t'item_category': product.category.name\n\t\t\t\t}))\n\t\t\t\tpayload.items = itemsToBePushed;\n\t\t\t\tpayload.cart_id = cart_id;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.VIEW_CART: {\n\t\t\t\tconst { cart_id, products, breakup_values_raw } = eventData;\n\t\t\t\tpayload.cart_id = cart_id;\n\t\t\t\tlet itemsToBePushed = [];\n\t\t\t\tproducts.forEach(product => {\n\t\t\t\t\tlet objectToBePushed = {\n\t\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t\t'discount': product.discount,\n\t\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t\t'price': product.price ? product.price.effective : '',\n\t\t\t\t\t\t'quantity': product.quantity.current,\n\t\t\t\t\t\t'item_category': product.category.name\n\t\t\t\t\t};\n\t\t\t\t\titemsToBePushed.push(objectToBePushed);\n\t\t\t\t})\n\t\t\t\tpayload.currency = 'INR';\n\t\t\t\tpayload.value = breakup_values_raw.subtotal\n\t\t\t\tpayload.items = itemsToBePushed;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.UPDATE_CART: {\n\t\t\t\tconst { cart_id, products, operation } = eventData;\n\t\t\t\tpayload.items = products.map(product => {\n\t\t\t\t\tconst price = product.price_per_unit.converted.effective\n\t\t\t\t\tconst quantity = product.quantity.current;\n\t\t\t\t\treturn {\n\t\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t\t'item_id': product.uid,\n\t\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t\t'item_category': product.category.name,\n\t\t\t\t\t\t'price': !isNaN(price * quantity) ? (price * quantity).toFixed(2) : '',\n\t\t\t\t\t\t'quantity': product.quantity.current,\n\t\t\t\t\t\t'currency': 'INR',\n\t\t\t\t\t}\n\t\t\t\t})\n\t\t\t\tpayload.cart_id = cart_id;\n\t\t\t\tpayload.event_action = operation === 'increment_quantity' ? FPI_EVENTS.ADD_TO_CART : operation === 'decrement_quantity' ? FPI_EVENTS.REMOVE_FROM_CART : event\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.ORDER_PROCESSED: {\n\t\t\t\tconst order_data = eventData;\n\t\t\t\tpayload.transaction_id = order_data.order_id,\n\t\t\t\tpayload.value = order_data.breakup_values_raw.total;\n\t\t\t\tpayload.shipping = order_data.breakup_values_raw.delivery_charges;\n\t\t\t\tpayload.currency = 'INR';\n\t\t\t\tpayload.coupon = order_data.breakup_values_raw.coupon\n\t\t\t\tpayload.items = order_data.items.map(product => {\n\t\t\t\t\treturn {\n\t\t\t\t\t\t'item_name': product.name,\n\t\t\t\t\t\t'item_id': product.id,\n\t\t\t\t\t\t'item_brand': product.brand.name,\n\t\t\t\t\t\t'item_price':  product.price,\n\t\t\t\t\t\t'item_quantity': product.quantity,\n\t\t\t\t\t\t'item_category': product.l1_categories ||  [],\n\t\t\t\t\t\t'item_category2': product.l2_categories || [],\n\t\t\t\t\t\t'item_category3': product.l3_category_name ? [product.l3_category_name] : [],\n\t\t\t\t\t}\n\t\t\t\t})\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase FPI_EVENTS.REFUND_SUCCESS: {\n\t\t\t\tconst { refund_data } = eventData;\n\t\t\t\tconst shipments = refund_data.statuses[0].shipments\n\t\t\t\tpayload.transaction_id = Object.keys(shipments)[0];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tdefault:\n\t\t\t\tpayload = eventData\n\t\t}\n\t\treturn payload;\n\t}\n\n\tconst pushToDataLayer = (event, eventData) => {\n\t\tconst payload = transformData(event, eventData);\n\t\tevent = payload.event_action ? payload.event_action : event;\n\t\tevent = getGTMEventName(event);\n\t\tif(event === 'not_known') return\n\t\tdataLayer.push({ ecommerce: null });\n\t\tpayload.userAgent = window.navigator.userAgent;\n\t\tdataLayer.push({\n\t\t\tevent,\n\t\t\tecommerce: payload,\n\t\t});\n\t};\n\n\n\tfunction getSkipEvents (){\n\t\tlet result = [];\n\t\ttry {\n\t\t\t\n\t\t\tresult = gtmeGetFPISkipEvents();\n\t\t\n\t\t} catch(e){\n\t\t\tconsole.log(\"NO_FILTERED_LOGIC_FOUND\");\n\t\t\tresult = []\n\t\t}\n\t\treturn result;\n\t}\n\n\n\tif (FPI) {\n\t\tObject.keys(FPI_EVENTS).filter((ev) => {\n\t\t\tconst skipEvents = getSkipEvents();\n\t\t\treturn skipEvents && skipEvents.includes(ev)? false: true\n\t\t}).forEach((event) => {\n\t\t\tFPI.event.on(FPI_EVENTS[event], (eventData) => {\n\t\t\t\tconsole.log(`FPI ${event}`);\n\t\t\t\tpushToDataLayer(FPI_EVENTS[event], eventData);\n\t\t\t});\n\t\t});\n\t}\n}\n\tlistener()\n\t\n\t",
38          "_id": "64dde81b619b84f27f4a896d",
39          "name": "google-tag-manager script",
40          "type": "js",
41          "sub_type": "inline",
42          "compatible_engines": [],
43          "position": "body-bottom",
44          "pages": [],
45          "__source": {
46            "type": "extension",
47            "id": "61384111bee79ce4ac848a57"
48          }
49        },
50        {
51          "url": "https://reviews.extensions.fynd.com/api/application/bindings/rating-review/rating-review.umd.min.js",
52          "_id": "660486ae8c301c79b83cafcb",
53          "name": "Reviews injection script",
54          "type": "js",
55          "sub_type": "external",
56          "compatible_engines": [],
57          "position": "body-bottom",
58          "pages": [],
59          "__source": {
60            "type": "extension",
61            "id": "6242ba839a6e7a3be7078885"
62          }
63        },
64        {
65          "url": "https://reviews.extensions.fynd.com/api/application/bindings/rating-review/rating-review.css",
66          "_id": "660486ae4f419feb069efde9",
67          "name": "Reviews injection style",
68          "type": "css",
69          "sub_type": "external",
70          "compatible_engines": [],
71          "position": "head",
72          "pages": [],
73          "__source": {
74            "type": "extension",
75            "id": "6242ba839a6e7a3be7078885"
76          }
77        }
78      ],
79      "application": "5eb2e60f5de52793c06ea942",
80      "company": "61",
81      "__v": 24
82    }
83  }
84}

application/tags/update/v1

this event is triggered when tag 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
tags
object
Required
Properties
__v
integer
Required
_id
string
Required
tags
array of object
Required
List of tags (either CSS/JS) that will be injected into website's HTML
Array of Properties
_id
string
name
string
Name given to the tag
type
string
Required
Type of Tag - whether it is CSS or JavaScript
content
string
position
string
Required
Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom
sub_type
string
Required
Tag is external or inline
company
string
Required
application
string
Required
ID of the application where the tags will be injected
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        "tags"
78      ],
79      "properties": {
80        "tags": {
81          "type": "object",
82          "required": [
83            "_id",
84            "tags",
85            "application",
86            "company",
87            "__v"
88          ],
89          "properties": {
90            "__v": {
91              "type": "integer"
92            },
93            "_id": {
94              "type": "string"
95            },
96            "tags": {
97              "type": "array",
98              "items": {
99                "type": "object",
100                "required": [
101                  "sub_type",
102                  "type",
103                  "position"
104                ],
105                "properties": {
106                  "_id": {
107                    "type": "string"
108                  },
109                  "name": {
110                    "type": "string",
111                    "description": "Name given to the tag"
112                  },
113                  "type": {
114                    "type": "string",
115                    "description": "Type of Tag - whether it is CSS or JavaScript"
116                  },
117                  "content": {
118                    "type": "string"
119                  },
120                  "position": {
121                    "type": "string",
122                    "description": "Position at which the tag is injected in HTML - whether it's in the head, body-top, or body-bottom"
123                  },
124                  "sub_type": {
125                    "type": "string",
126                    "description": "Tag is external or inline"
127                  }
128                }
129              },
130              "description": "List of tags (either CSS/JS) that will be injected into website's HTML"
131            },
132            "company": {
133              "type": "string"
134            },
135            "application": {
136              "type": "string",
137              "description": "ID of the application where the tags will be injected"
138            }
139          }
140        }
141      }
142    }
143  }
144}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "convex.0a3110ae-fd89-4273-9797-c5ab12496d6d"
5    ],
6    "name": "tags",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712080722856,
10    "id": "5jnqTqcIiT54IoMnYVuX3HrZ0gmA2Fb6FS7Zz0Iglgg=",
11    "category": "application"
12  },
13  "company_id": 884,
14  "application_id": "000000000000000000000001",
15  "contains": [
16    "tags"
17  ],
18  "payload": {
19    "tags": {
20      "_id": "5f7c37b2dd0144bb3a353c5f",
21      "tags": [],
22      "application": "000000000000000000000001",
23      "company": "884",
24      "__v": 328
25    }
26  }
27}

Theme

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

Events
application/theme/create/v1
# This event is triggered when theme is created
application/theme/delete/v1
# This event is triggered when theme is deleted
application/theme/update/v1
# This event is triggered when theme is updated

application/theme/create/v1

This event is triggered when theme is created

Payload
Properties
application_id
array|string
Required
Application ID(Sales Channel) 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 Style configuration for theme.
Properties
_id
string
Unique theme ID
font
object
Font configurations
Properties
family
string
The font family.
variants
object
Font variants available for the font family.
Properties
bold
object
The bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
light
object
The light variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
medium
object
The medium variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
regular
object
The regular variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
semi_bold
object
The semi-bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
meta
object
Meta configurations of a theme
name
string
Name of the theme
tags
array of string
Tags for the theme
config
object
Theme configuration details
Properties
list
array of object
An array of items.
Array of Properties
name
string
Name of the item.
page
array of object
An array of pages.
Array of Properties
settings
object
Settings for the page.
Properties
props
object
Properties for the page.
Properties
page
string
Name of the page.
styles
object
Styling details of theme
applied
boolean
Theme is currently applied or not
created_at
string
Timestamp when theme was created
is_private
boolean
If the theme is private or not
theme_type
string
Theme type being either Vue2 or React
updated_at
string
When was the theme object last modified
application_id
string
Required
Application ID to which the theme belongs
template_theme_id
string
marketplace_theme_id
string
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 ID(Sales Channel) 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            "application_id"
84          ],
85          "description": "Theme Style configuration for theme.",
86          "properties": {
87            "_id": {
88              "type": "string",
89              "description": "Unique theme ID"
90            },
91            "font": {
92              "type": "object",
93              "properties": {
94                "family": {
95                  "type": "string",
96                  "description": "The font family."
97                },
98                "variants": {
99                  "type": "object",
100                  "description": "Font variants available for the font family.",
101                  "properties": {
102                    "bold": {
103                      "type": "object",
104                      "description": "The bold variant of the font.",
105                      "properties": {
106                        "file": {
107                          "type": "string",
108                          "description": "File path or URL for the font file."
109                        },
110                        "name": {
111                          "type": "string",
112                          "description": "Name of the font variant."
113                        }
114                      }
115                    },
116                    "light": {
117                      "type": "object",
118                      "description": "The light variant of the font.",
119                      "properties": {
120                        "file": {
121                          "type": "string",
122                          "description": "File path or URL for the font file."
123                        },
124                        "name": {
125                          "type": "string",
126                          "description": "Name of the font variant."
127                        }
128                      }
129                    },
130                    "medium": {
131                      "type": "object",
132                      "description": "The medium variant of the font.",
133                      "properties": {
134                        "file": {
135                          "type": "string",
136                          "description": "File path or URL for the font file."
137                        },
138                        "name": {
139                          "type": "string",
140                          "description": "Name of the font variant."
141                        }
142                      }
143                    },
144                    "regular": {
145                      "type": "object",
146                      "description": "The regular variant of the font.",
147                      "properties": {
148                        "file": {
149                          "type": "string",
150                          "description": "File path or URL for the font file."
151                        },
152                        "name": {
153                          "type": "string",
154                          "description": "Name of the font variant."
155                        }
156                      }
157                    },
158                    "semi_bold": {
159                      "type": "object",
160                      "description": "The semi-bold variant of the font.",
161                      "properties": {
162                        "file": {
163                          "type": "string",
164                          "description": "File path or URL for the font file."
165                        },
166                        "name": {
167                          "type": "string",
168                          "description": "Name of the font variant."
169                        }
170                      }
171                    }
172                  }
173                }
174              },
175              "description": "Font configurations"
176            },
177            "meta": {
178              "type": "object",
179              "description": "Meta configurations of a theme"
180            },
181            "name": {
182              "type": "string",
183              "description": "Name of the theme"
184            },
185            "tags": {
186              "type": "array",
187              "description": "Tags for the theme",
188              "items": {
189                "type": "string",
190                "description": "Details of third party scripts that will get injected in theme"
191              }
192            },
193            "config": {
194              "type": "object",
195              "properties": {
196                "list": {
197                  "type": "array",
198                  "description": "An array of items.",
199                  "items": {
200                    "type": "object",
201                    "properties": {
202                      "name": {
203                        "type": "string",
204                        "description": "Name of the item."
205                      },
206                      "page": {
207                        "type": "array",
208                        "description": "An array of pages.",
209                        "items": {
210                          "type": "object",
211                          "properties": {
212                            "settings": {
213                              "type": "object",
214                              "description": "Settings for the page.",
215                              "properties": {
216                                "props": {
217                                  "type": "object",
218                                  "description": "Properties for the page.",
219                                  "properties": {
220                                    "page": {
221                                      "type": "string",
222                                      "description": "Name of the page."
223                                    }
224                                  }
225                                }
226                              }
227                            }
228                          }
229                        },
230                        "global_config": {
231                          "type": "object",
232                          "properties": {
233                            "static": {
234                              "type": "object",
235                              "properties": {
236                                "props": {
237                                  "type": "object",
238                                  "properties": {
239                                    "colors": {
240                                      "type": "object",
241                                      "properties": {
242                                        "primary_color": {
243                                          "type": "string",
244                                          "description": "The main color used for branding and primary elements."
245                                        },
246                                        "secondary_color": {
247                                          "type": "string",
248                                          "description": "A supporting color used alongside the primary color for additional design elements."
249                                        },
250                                        "accent_color": {
251                                          "type": "string",
252                                          "description": "A color used to highlight specific elements and create visual interest."
253                                        },
254                                        "link_color": {
255                                          "type": "string",
256                                          "description": "The color used for hyperlinks and interactive elements such as buttons."
257                                        },
258                                        "button_secondary_color": {
259                                          "type": "string",
260                                          "description": "An alternate color option for buttons, typically used in conjunction with the primary button color."
261                                        },
262                                        "bg_color": {
263                                          "type": "string",
264                                          "description": "The background color of the interface or layout."
265                                        }
266                                      }
267                                    },
268                                    "auth": {
269                                      "type": "object",
270                                      "properties": {
271                                        "show_header_auth": {
272                                          "type": "boolean",
273                                          "description": "Determines whether authentication options should be displayed in the header of the interface."
274                                        },
275                                        "show_footer_auth": {
276                                          "type": "boolean",
277                                          "description": "Determines whether authentication options should be displayed in the footer of the interface."
278                                        }
279                                      }
280                                    },
281                                    "palette": {
282                                      "type": "object",
283                                      "properties": {
284                                        "general_setting": {
285                                          "type": "object",
286                                          "properties": {
287                                            "theme": {
288                                              "type": "object",
289                                              "properties": {
290                                                "page_background": {
291                                                  "type": "string",
292                                                  "description": "The background color of the page."
293                                                },
294                                                "theme_accent": {
295                                                  "type": "string",
296                                                  "description": "The accent color used throughout the theme for highlights and accents."
297                                                }
298                                              }
299                                            },
300                                            "text": {
301                                              "type": "object",
302                                              "properties": {
303                                                "text_heading": {
304                                                  "type": "string",
305                                                  "description": "The color of heading text."
306                                                },
307                                                "text_body": {
308                                                  "type": "string",
309                                                  "description": "The color of body text."
310                                                },
311                                                "text_label": {
312                                                  "type": "string",
313                                                  "description": "The color of labels or secondary text."
314                                                },
315                                                "text_secondary": {
316                                                  "type": "string",
317                                                  "description": "The color of secondary text elements."
318                                                }
319                                              }
320                                            },
321                                            "button": {
322                                              "type": "object",
323                                              "properties": {
324                                                "button_primary": {
325                                                  "type": "string",
326                                                  "description": "The color of primary buttons."
327                                                },
328                                                "button_secondary": {
329                                                  "type": "string",
330                                                  "description": "The color of secondary buttons."
331                                                },
332                                                "button_link": {
333                                                  "type": "string",
334                                                  "description": "The color of hyperlink buttons."
335                                                }
336                                              }
337                                            },
338                                            "sale_discount": {
339                                              "type": "object",
340                                              "properties": {
341                                                "sale_badge_background": {
342                                                  "type": "string",
343                                                  "description": "The background color of sale badges."
344                                                },
345                                                "sale_badge_text": {
346                                                  "type": "string",
347                                                  "description": "The color of text on sale badges."
348                                                },
349                                                "sale_discount_text": {
350                                                  "type": "string",
351                                                  "description": "The color of text indicating discounts."
352                                                },
353                                                "sale_timer": {
354                                                  "type": "string",
355                                                  "description": "The color of the timer for sales."
356                                                }
357                                              }
358                                            },
359                                            "header": {
360                                              "type": "object",
361                                              "properties": {
362                                                "header_background": {
363                                                  "type": "string",
364                                                  "description": "The background color of the header."
365                                                },
366                                                "header_nav": {
367                                                  "type": "string",
368                                                  "description": "The color of navigation links in the header."
369                                                },
370                                                "header_icon": {
371                                                  "type": "string",
372                                                  "description": "The color of icons in the header."
373                                                }
374                                              }
375                                            },
376                                            "footer": {
377                                              "type": "object",
378                                              "properties": {
379                                                "footer_background": {
380                                                  "type": "string",
381                                                  "description": "The background color of the footer."
382                                                },
383                                                "footer_bottom_background": {
384                                                  "type": "string",
385                                                  "description": "The background color of the bottom section of the footer."
386                                                },
387                                                "footer_heading_text": {
388                                                  "type": "string",
389                                                  "description": "The color of heading text in the footer."
390                                                },
391                                                "footer_body_text": {
392                                                  "type": "string",
393                                                  "description": "The color of body text in the footer."
394                                                },
395                                                "footer_icon": {
396                                                  "type": "string",
397                                                  "description": "The color of icons in the footer."
398                                                }
399                                              }
400                                            }
401                                          }
402                                        },
403                                        "advance_setting": {
404                                          "type": "object",
405                                          "properties": {
406                                            "overlay_popup": {
407                                              "type": "object",
408                                              "properties": {
409                                                "dialog_backgroung": {
410                                                  "type": "string",
411                                                  "description": "The background color of dialog boxes in overlay popups."
412                                                },
413                                                "overlay": {
414                                                  "type": "string",
415                                                  "description": "The color of the overlay used in overlay popups."
416                                                }
417                                              }
418                                            },
419                                            "divider_stroke_highlight": {
420                                              "type": "object",
421                                              "properties": {
422                                                "divider_strokes": {
423                                                  "type": "string",
424                                                  "description": "The color of divider strokes."
425                                                },
426                                                "highlight": {
427                                                  "type": "string",
428                                                  "description": "The color used to highlight divider strokes."
429                                                }
430                                              }
431                                            },
432                                            "user_alerts": {
433                                              "type": "object",
434                                              "properties": {
435                                                "success_background": {
436                                                  "type": "string",
437                                                  "description": "The background color for success alerts."
438                                                },
439                                                "success_text": {
440                                                  "type": "string",
441                                                  "description": "The color of text in success alerts."
442                                                },
443                                                "error_background": {
444                                                  "type": "string",
445                                                  "description": "The background color for error alerts."
446                                                },
447                                                "error_text": {
448                                                  "type": "string",
449                                                  "description": "The color of text in error alerts."
450                                                },
451                                                "info_background": {
452                                                  "type": "string",
453                                                  "description": "The background color for informational alerts."
454                                                },
455                                                "info_text": {
456                                                  "type": "string",
457                                                  "description": "The color of text in informational alerts."
458                                                }
459                                              }
460                                            }
461                                          },
462                                          "description": "Colors of specific elements within the application facade."
463                                        }
464                                      }
465                                    },
466                                    "order_tracking": {
467                                      "type": "object",
468                                      "properties": {
469                                        "show_header": {
470                                          "type": "boolean",
471                                          "description": "Determines whether order tracking information should be displayed in the header of the interface."
472                                        },
473                                        "show_footer": {
474                                          "type": "boolean",
475                                          "description": "Determines whether order tracking information should be displayed in the footer of the interface."
476                                        }
477                                      }
478                                    },
479                                    "extension": {
480                                      "type": "object",
481                                      "description": "Additional settings or features that extend the functionality of the theme tracking system."
482                                    }
483                                  }
484                                }
485                              }
486                            },
487                            "custom": {
488                              "type": "object",
489                              "properties": {
490                                "header_bg_color": {
491                                  "type": "string",
492                                  "description": "Background color of the header."
493                                },
494                                "header_text_color": {
495                                  "type": "string",
496                                  "description": "Color of text in the header."
497                                },
498                                "header_border_color": {
499                                  "type": "string",
500                                  "description": "Color of borders in the header."
501                                },
502                                "header_icon_color": {
503                                  "type": "string",
504                                  "description": "Color of icons in the header."
505                                },
506                                "header_cart_notification_bg_color": {
507                                  "type": "string",
508                                  "description": "Background color of the cart notification in the header."
509                                },
510                                "header_cart_notification_text_color": {
511                                  "type": "string",
512                                  "description": "Color of text in the cart notification in the header."
513                                },
514                                "header_nav_hover_color": {
515                                  "type": "string",
516                                  "description": "Color of navigation links when hovered over in the header."
517                                },
518                                "button_primary_color": {
519                                  "type": "string",
520                                  "description": "Color of primary buttons."
521                                },
522                                "button_primary_label_color": {
523                                  "type": "string",
524                                  "description": "Color of labels/text on primary buttons."
525                                },
526                                "button_add_to_cart_color": {
527                                  "type": "string",
528                                  "description": "Color of 'Add to Cart' buttons."
529                                },
530                                "button_add_to_cart_label_color": {
531                                  "type": "string",
532                                  "description": "Color of labels/text on 'Add to Cart' buttons."
533                                },
534                                "button_secondary_color": {
535                                  "type": "string",
536                                  "description": "Color of secondary buttons."
537                                },
538                                "button_secondary_label_color": {
539                                  "type": "string",
540                                  "description": "Color of labels/text on secondary buttons."
541                                },
542                                "button_tertiary_color": {
543                                  "type": "string",
544                                  "description": "Color of tertiary buttons."
545                                },
546                                "button_tertiary_label_color": {
547                                  "type": "string",
548                                  "description": "Color of labels/text on tertiary buttons."
549                                },
550                                "button_tertiary_hover_color": {
551                                  "type": "string",
552                                  "description": "Background color of tertiary buttons when hovered over."
553                                },
554                                "button_tertiary_hover_text_color": {
555                                  "type": "string",
556                                  "description": "Color of text on tertiary buttons when hovered over."
557                                },
558                                "text_heading_link_color": {
559                                  "type": "string",
560                                  "description": "Color of links within headings."
561                                },
562                                "text_body_color": {
563                                  "type": "string",
564                                  "description": "Color of body text."
565                                },
566                                "text_price_color": {
567                                  "type": "string",
568                                  "description": "Color of regular price text."
569                                },
570                                "text_sale_price_color": {
571                                  "type": "string",
572                                  "description": "Color of sale price text."
573                                },
574                                "text_strikethrough_price_color": {
575                                  "type": "string",
576                                  "description": "Color of strikethrough price text."
577                                },
578                                "text_discount_color": {
579                                  "type": "string",
580                                  "description": "Color of discount text."
581                                },
582                                "footer_bg_color": {
583                                  "type": "string",
584                                  "description": "Background color of the footer."
585                                },
586                                "footer_text_color": {
587                                  "type": "string",
588                                  "description": "Color of text in the footer."
589                                },
590                                "footer_border_color": {
591                                  "type": "string",
592                                  "description": "Color of borders in the footer."
593                                },
594                                "footer_nav_hover_color": {
595                                  "type": "string",
596                                  "description": "Color of navigation links when hovered over in the footer."
597                                }
598                              }
599                            }
600                          }
601                        }
602                      }
603                    }
604                  },
605                  "current": {
606                    "type": "string"
607                  }
608                }
609              },
610              "description": "Theme configuration details"
611            },
612            "styles": {
613              "type": "object",
614              "description": "Styling details of theme"
615            },
616            "applied": {
617              "type": "boolean",
618              "description": "Theme is currently applied or not"
619            },
620            "created_at": {
621              "type": "string",
622              "description": "Timestamp when theme was created"
623            },
624            "is_private": {
625              "type": "boolean",
626              "description": "If the theme is private or not"
627            },
628            "theme_type": {
629              "type": "string",
630              "description": "Theme type being either Vue2 or React"
631            },
632            "updated_at": {
633              "type": "string",
634              "description": "When was the theme object last modified"
635            },
636            "application_id": {
637              "type": "string",
638              "description": "Application ID to which the theme belongs"
639            },
640            "template_theme_id": {
641              "type": "string"
642            },
643            "marketplace_theme_id": {
644              "type": "string"
645            }
646          }
647        }
648      }
649    }
650  }
651}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.99330fb7-6e90-4b6a-a752-b677b25ab9fd"
5    ],
6    "name": "theme",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711688594545,
10    "id": "7de1ln+pc9u/rPBXCANk7wCR1mu/kwg2hFJk4pf8TUs=",
11    "category": "application"
12  },
13  "company_id": 7149,
14  "application_id": "66064b88706c09f2685bddae",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "name": "Bodil",
21      "application_id": "66064b88706c09f2685bddae",
22      "company_id": 7149,
23      "marketplace_theme_id": "654272f1f941373a765eb275",
24      "template_theme_id": "6542767f2e38b2ca1c51aa8f",
25      "applied": false,
26      "is_private": false,
27      "version": "1.0.3",
28      "font": {
29        "variants": {
30          "light": {
31            "name": "300",
32            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"
33          },
34          "regular": {
35            "name": "regular",
36            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"
37          },
38          "medium": {
39            "name": "500",
40            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"
41          },
42          "semi_bold": {
43            "name": "600",
44            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"
45          },
46          "bold": {
47            "name": "700",
48            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"
49          }
50        },
51        "family": "Poppins"
52      },
53      "config": {
54        "current": "Default",
55        "list": [
56          {
57            "name": "Default",
58            "global_config": {
59              "static": {
60                "props": {
61                  "colors": {
62                    "primary_color": "#000000",
63                    "secondary_color": "#000000",
64                    "accent_color": "#000000",
65                    "link_color": "#4499FF",
66                    "button_secondary_color": "#000000",
67                    "bg_color": "#683b46"
68                  },
69                  "auth": {
70                    "show_header_auth": true,
71                    "show_footer_auth": true
72                  },
73                  "palette": {
74                    "general_setting": {
75                      "theme": {
76                        "page_background": "#683b46",
77                        "theme_accent": "#000000"
78                      },
79                      "text": {
80                        "text_heading": "#000000",
81                        "text_body": "#3C3131",
82                        "text_label": "#7D7676",
83                        "text_secondary": "#9C9C9C"
84                      },
85                      "button": {
86                        "button_primary": "#000000",
87                        "button_secondary": "#000000",
88                        "button_link": "#4499FF"
89                      },
90                      "sale_discount": {
91                        "sale_badge_background": "#FFFFFF",
92                        "sale_badge_text": "#1C958F",
93                        "sale_discount_text": "#1C958F",
94                        "sale_timer": "#994449"
95                      },
96                      "header": {
97                        "header_background": "#F3F3ED",
98                        "header_nav": "#261A1A",
99                        "header_icon": "#261A1A"
100                      },
101                      "footer": {
102                        "footer_background": "#2C231E",
103                        "footer_bottom_background": "#231812",
104                        "footer_heading_text": "#FFFFFF",
105                        "footer_body_text": "#FFFFFF",
106                        "footer_icon": "#FFFFFF"
107                      }
108                    },
109                    "advance_setting": {
110                      "overlay_popup": {
111                        "dialog_backgroung": "#FFFFFF",
112                        "overlay": "#14130E"
113                      },
114                      "divider_stroke_highlight": {
115                        "divider_strokes": "#D4D1D1",
116                        "highlight": "#EDECE9"
117                      },
118                      "user_alerts": {
119                        "success_background": "#C2DBC9",
120                        "success_text": "#1C958F",
121                        "error_background": "#E6D5D5",
122                        "error_text": "#B24141",
123                        "info_background": "#EBD3BC",
124                        "info_text": "#D28F51"
125                      }
126                    }
127                  },
128                  "extension": {
129                    "header_top": [],
130                    "header_bottom": [],
131                    "footer_top": [],
132                    "footer_bottom": []
133                  },
134                  "order_tracking": {
135                    "show_header": true,
136                    "show_footer": true
137                  }
138                }
139              },
140              "custom": {
141                "props": {
142                  "header_bg_color": "#ffffff",
143                  "header_text_color": "#000000",
144                  "header_border_color": "#e1e1e1",
145                  "header_icon_color": "#000000",
146                  "header_cart_notification_bg_color": "#e8a76c",
147                  "header_cart_notification_text_color": "#ffffff",
148                  "header_nav_hover_color": "#999999",
149                  "button_primary_color": "#ffffff",
150                  "button_primary_label_color": "#000000",
151                  "button_add_to_cart_color": "#000000",
152                  "button_add_to_cart_label_color": "#ffffff",
153                  "button_secondary_color": "#000000",
154                  "button_secondary_label_color": "#ffffff",
155                  "button_tertiary_color": "#000000",
156                  "button_tertiary_label_color": "#000000",
157                  "button_tertiary_hover_color": "#000000",
158                  "button_tertiary_hover_text_color": "#ffffff",
159                  "text_heading_link_color": "#000000",
160                  "text_body_color": "#000000",
161                  "text_price_color": "#000000",
162                  "text_sale_price_color": "#fb406b",
163                  "text_strikethrough_price_color": "#9b9b9b",
164                  "text_discount_color": "#ee478d",
165                  "footer_bg_color": "#ffffff",
166                  "footer_text_color": "#999999",
167                  "footer_border_color": "#e1e1e1",
168                  "footer_nav_hover_color": "#000000",
169                  "disable_cart": false,
170                  "is_menu_below_logo": false,
171                  "menu_position": "left"
172                }
173              }
174            },
175            "page": []
176          },
177          {
178            "name": "Dark",
179            "global_config": {
180              "static": {
181                "props": {
182                  "colors": {
183                    "primary_color": "#000000",
184                    "secondary_color": "#000000",
185                    "accent_color": "#000000",
186                    "link_color": "#4499FF",
187                    "button_secondary_color": "#000000",
188                    "bg_color": "#F8F8F8"
189                  },
190                  "auth": {
191                    "show_header_auth": false,
192                    "show_footer_auth": false
193                  },
194                  "palette": {
195                    "general_setting": {
196                      "theme": {
197                        "page_background": "#F8F8F8",
198                        "theme_accent": "#000000"
199                      },
200                      "text": {
201                        "text_heading": "#000000",
202                        "text_body": "#3C3131",
203                        "text_label": "#7D7676",
204                        "text_secondary": "#9C9C9C"
205                      },
206                      "button": {
207                        "button_primary": "#000000",
208                        "button_secondary": "#000000",
209                        "button_link": "#4499FF"
210                      },
211                      "sale_discount": {
212                        "sale_badge_background": "#FFFFFF",
213                        "sale_badge_text": "#1C958F",
214                        "sale_discount_text": "#1C958F",
215                        "sale_timer": "#994449"
216                      },
217                      "header": {
218                        "header_background": "#F3F3ED",
219                        "header_nav": "#261A1A",
220                        "header_icon": "#261A1A"
221                      },
222                      "footer": {
223                        "footer_background": "#2C231E",
224                        "footer_bottom_background": "#231812",
225                        "footer_heading_text": "#FFFFFF",
226                        "footer_body_text": "#FFFFFF",
227                        "footer_icon": "#FFFFFF"
228                      }
229                    },
230                    "advance_setting": {
231                      "overlay_popup": {
232                        "dialog_backgroung": "#FFFFFF",
233                        "overlay": "#14130E"
234                      },
235                      "divider_stroke_highlight": {
236                        "divider_strokes": "#D4D1D1",
237                        "highlight": "#EDECE9"
238                      },
239                      "user_alerts": {
240                        "success_background": "#C2DBC9",
241                        "success_text": "#1C958F",
242                        "error_background": "#E6D5D5",
243                        "error_text": "#B24141",
244                        "info_background": "#EBD3BC",
245                        "info_text": "#D28F51"
246                      }
247                    }
248                  },
249                  "extension": {
250                    "header_top": [],
251                    "header_bottom": [],
252                    "footer_top": [],
253                    "footer_bottom": []
254                  },
255                  "order_tracking": {
256                    "show_header": true,
257                    "show_footer": true
258                  }
259                }
260              },
261              "custom": {
262                "props": {
263                  "header_bg_color": "#2e3032",
264                  "header_text_color": "#ffffff",
265                  "header_border_color": "#FFFFFF",
266                  "header_icon_color": "#ffffff",
267                  "header_cart_notification_bg_color": "#FFFFFF",
268                  "header_cart_notification_text_color": "#2e3032",
269                  "header_nav_hover_color": "#000000",
270                  "button_primary_color": "#000000",
271                  "button_primary_label_color": "#ffffff",
272                  "button_add_to_cart_color": "#000000",
273                  "button_add_to_cart_label_color": "#ffffff",
274                  "button_secondary_color": "#000000",
275                  "button_secondary_label_color": "#ffffff",
276                  "button_tertiary_color": "#000000",
277                  "button_tertiary_label_color": "#000000",
278                  "button_tertiary_hover_color": "#000000",
279                  "button_tertiary_hover_text_color": "#ffffff",
280                  "text_heading_link_color": "#000000",
281                  "text_body_color": "#000000",
282                  "text_price_color": "#000000",
283                  "text_sale_price_color": "#fb406b",
284                  "text_strikethrough_price_color": "#9b9b9b",
285                  "text_discount_color": "#ee478d",
286                  "footer_bg_color": "#2e3032",
287                  "footer_text_color": "#ffffff",
288                  "footer_border_color": "#FFFFFF",
289                  "footer_nav_hover_color": "#ffffff"
290                }
291              }
292            },
293            "page": []
294          },
295          {
296            "name": "Blue",
297            "global_config": {
298              "static": {
299                "props": {
300                  "colors": {
301                    "primary_color": "#000000",
302                    "secondary_color": "#000000",
303                    "accent_color": "#000000",
304                    "link_color": "#4499FF",
305                    "button_secondary_color": "#000000",
306                    "bg_color": "#F8F8F8"
307                  },
308                  "auth": {
309                    "show_header_auth": false,
310                    "show_footer_auth": false
311                  },
312                  "palette": {
313                    "general_setting": {
314                      "theme": {
315                        "page_background": "#F8F8F8",
316                        "theme_accent": "#000000"
317                      },
318                      "text": {
319                        "text_heading": "#000000",
320                        "text_body": "#3C3131",
321                        "text_label": "#7D7676",
322                        "text_secondary": "#9C9C9C"
323                      },
324                      "button": {
325                        "button_primary": "#000000",
326                        "button_secondary": "#000000",
327                        "button_link": "#4499FF"
328                      },
329                      "sale_discount": {
330                        "sale_badge_background": "#FFFFFF",
331                        "sale_badge_text": "#1C958F",
332                        "sale_discount_text": "#1C958F",
333                        "sale_timer": "#994449"
334                      },
335                      "header": {
336                        "header_background": "#F3F3ED",
337                        "header_nav": "#261A1A",
338                        "header_icon": "#261A1A"
339                      },
340                      "footer": {
341                        "footer_background": "#2C231E",
342                        "footer_bottom_background": "#231812",
343                        "footer_heading_text": "#FFFFFF",
344                        "footer_body_text": "#FFFFFF",
345                        "footer_icon": "#FFFFFF"
346                      }
347                    },
348                    "advance_setting": {
349                      "overlay_popup": {
350                        "dialog_backgroung": "#FFFFFF",
351                        "overlay": "#14130E"
352                      },
353                      "divider_stroke_highlight": {
354                        "divider_strokes": "#D4D1D1",
355                        "highlight": "#EDECE9"
356                      },
357                      "user_alerts": {
358                        "success_background": "#C2DBC9",
359                        "success_text": "#1C958F",
360                        "error_background": "#E6D5D5",
361                        "error_text": "#B24141",
362                        "info_background": "#EBD3BC",
363                        "info_text": "#D28F51"
364                      }
365                    }
366                  },
367                  "extension": {
368                    "header_top": [],
369                    "header_bottom": [],
370                    "footer_top": [],
371                    "footer_bottom": []
372                  },
373                  "order_tracking": {
374                    "show_header": true,
375                    "show_footer": true
376                  }
377                }
378              },
379              "custom": {
380                "props": {
381                  "header_bg_color": "#7f9ed0",
382                  "header_text_color": "#FFFFFF",
383                  "header_border_color": "#FFFFFF",
384                  "header_icon_color": "#FFFFFF",
385                  "header_cart_notification_bg_color": "#2e3032",
386                  "header_cart_notification_text_color": "#FFFFFF",
387                  "header_nav_hover_color": "#2e3032",
388                  "button_primary_color": "#ffffff",
389                  "button_primary_label_color": "#000000",
390                  "button_add_to_cart_color": "#000000",
391                  "button_add_to_cart_label_color": "#ffffff",
392                  "button_secondary_color": "#000000",
393                  "button_secondary_label_color": "#ffffff",
394                  "button_tertiary_color": "#000000",
395                  "button_tertiary_label_color": "#000000",
396                  "button_tertiary_hover_color": "#000000",
397                  "button_tertiary_hover_text_color": "#ffffff",
398                  "text_heading_link_color": "#000000",
399                  "text_body_color": "#000000",
400                  "text_price_color": "#000000",
401                  "text_sale_price_color": "#fb406b",
402                  "text_strikethrough_price_color": "#9b9b9b",
403                  "text_discount_color": "#ee478d",
404                  "footer_bg_color": "#7f9ed0",
405                  "footer_text_color": "#FFFFFF",
406                  "footer_border_color": "#FFFFFF",
407                  "footer_nav_hover_color": "#2e3032"
408                }
409              }
410            },
411            "page": []
412          }
413        ]
414      },
415      "tags": [
416        "ASTRA"
417      ],
418      "meta": {
419        "description": "Welcome to BODIL, where minimalism meets functionality. Explore our sleek storefront designed to simplify your shopping experience. From captivating banners to streamlined checkouts, we've got you covered.",
420        "industry": [
421          "Arts and crafts",
422          "Restaurants",
423          "Toys and games"
424        ],
425        "release": {
426          "notes": "<p><strong data-stringify-type=\"bold\">Release Note - Version 1.0.3<br /></strong></p>\n<p>CDN Link migration for smooth flow.</p>\n<p>&nbsp;</p>",
427          "version": "1.0.3"
428        },
429        "payment": {
430          "is_paid": false,
431          "amount": 0
432        },
433        "images": {
434          "desktop": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/gq_Vt4Pn1-desktop.png",
435          "mobile": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/w-oFgufM9-mobile.png"
436        },
437        "slug": "bodil",
438        "name": "Bodil"
439      },
440      "theme_type": "vue2",
441      "_id": "66064b8fb114315f02450b32",
442      "styles": {},
443      "global_sections": [],
444      "created_at": "2024-03-29T05:03:11.930Z",
445      "updated_at": "2024-03-29T05:03:11.930Z"
446    }
447  }
448}

application/theme/delete/v1

This event is triggered when theme is deleted

Payload
Properties
application_id
array|string
Required
Application ID(Sales Channel) 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 Style configuration for theme.
Properties
_id
string
Unique theme ID
font
object
Font configurations
Properties
family
string
The font family.
variants
object
Font variants available for the font family.
Properties
bold
object
The bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
light
object
The light variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
medium
object
The medium variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
regular
object
The regular variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
semi_bold
object
The semi-bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
meta
object
Meta configurations of a theme
name
string
Name of the theme
tags
array of string
Tags for the theme
config
object
Theme configuration details
Properties
list
array of object
An array of items.
Array of Properties
name
string
Name of the item.
page
array of object
An array of pages.
Array of Properties
settings
object
Settings for the page.
Properties
props
object
Properties for the page.
Properties
page
string
Name of the page.
styles
object
Styling details of theme
applied
boolean
Theme is currently applied or not
created_at
string
Timestamp when theme was created
is_private
boolean
If the theme is private or not
theme_type
string
Theme type being either Vue2 or React
updated_at
string
When was the theme object last modified
application_id
string
Required
Application ID to which the theme belongs
template_theme_id
string
Template ID of the theme
marketplace_theme_id
string
Marketplace ID which has the theme configured
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 ID(Sales Channel) 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            "application_id"
84          ],
85          "description": "Theme Style configuration for theme.",
86          "properties": {
87            "_id": {
88              "type": "string",
89              "description": "Unique theme ID"
90            },
91            "font": {
92              "type": "object",
93              "properties": {
94                "family": {
95                  "type": "string",
96                  "description": "The font family."
97                },
98                "variants": {
99                  "type": "object",
100                  "description": "Font variants available for the font family.",
101                  "properties": {
102                    "bold": {
103                      "type": "object",
104                      "description": "The bold variant of the font.",
105                      "properties": {
106                        "file": {
107                          "type": "string",
108                          "description": "File path or URL for the font file."
109                        },
110                        "name": {
111                          "type": "string",
112                          "description": "Name of the font variant."
113                        }
114                      }
115                    },
116                    "light": {
117                      "type": "object",
118                      "description": "The light variant of the font.",
119                      "properties": {
120                        "file": {
121                          "type": "string",
122                          "description": "File path or URL for the font file."
123                        },
124                        "name": {
125                          "type": "string",
126                          "description": "Name of the font variant."
127                        }
128                      }
129                    },
130                    "medium": {
131                      "type": "object",
132                      "description": "The medium variant of the font.",
133                      "properties": {
134                        "file": {
135                          "type": "string",
136                          "description": "File path or URL for the font file."
137                        },
138                        "name": {
139                          "type": "string",
140                          "description": "Name of the font variant."
141                        }
142                      }
143                    },
144                    "regular": {
145                      "type": "object",
146                      "description": "The regular variant of the font.",
147                      "properties": {
148                        "file": {
149                          "type": "string",
150                          "description": "File path or URL for the font file."
151                        },
152                        "name": {
153                          "type": "string",
154                          "description": "Name of the font variant."
155                        }
156                      }
157                    },
158                    "semi_bold": {
159                      "type": "object",
160                      "description": "The semi-bold variant of the font.",
161                      "properties": {
162                        "file": {
163                          "type": "string",
164                          "description": "File path or URL for the font file."
165                        },
166                        "name": {
167                          "type": "string",
168                          "description": "Name of the font variant."
169                        }
170                      }
171                    }
172                  }
173                }
174              },
175              "description": "Font configurations"
176            },
177            "meta": {
178              "type": "object",
179              "description": "Meta configurations of a theme"
180            },
181            "name": {
182              "type": "string",
183              "description": "Name of the theme"
184            },
185            "tags": {
186              "type": "array",
187              "description": "Tags for the theme",
188              "items": {
189                "type": "string",
190                "description": "Details of third party scripts that will get injected in theme"
191              }
192            },
193            "config": {
194              "type": "object",
195              "properties": {
196                "list": {
197                  "type": "array",
198                  "description": "An array of items.",
199                  "items": {
200                    "type": "object",
201                    "properties": {
202                      "name": {
203                        "type": "string",
204                        "description": "Name of the item."
205                      },
206                      "page": {
207                        "type": "array",
208                        "description": "An array of pages.",
209                        "items": {
210                          "type": "object",
211                          "properties": {
212                            "settings": {
213                              "type": "object",
214                              "description": "Settings for the page.",
215                              "properties": {
216                                "props": {
217                                  "type": "object",
218                                  "description": "Properties for the page.",
219                                  "properties": {
220                                    "page": {
221                                      "type": "string",
222                                      "description": "Name of the page."
223                                    }
224                                  }
225                                }
226                              }
227                            }
228                          }
229                        },
230                        "global_config": {
231                          "type": "object",
232                          "properties": {
233                            "static": {
234                              "type": "object",
235                              "properties": {
236                                "props": {
237                                  "type": "object",
238                                  "properties": {
239                                    "colors": {
240                                      "type": "object",
241                                      "properties": {
242                                        "primary_color": {
243                                          "type": "string",
244                                          "description": "The main color used for branding and primary elements."
245                                        },
246                                        "secondary_color": {
247                                          "type": "string",
248                                          "description": "A supporting color used alongside the primary color for additional design elements."
249                                        },
250                                        "accent_color": {
251                                          "type": "string",
252                                          "description": "A color used to highlight specific elements and create visual interest."
253                                        },
254                                        "link_color": {
255                                          "type": "string",
256                                          "description": "The color used for hyperlinks and interactive elements such as buttons."
257                                        },
258                                        "button_secondary_color": {
259                                          "type": "string",
260                                          "description": "An alternate color option for buttons, typically used in conjunction with the primary button color."
261                                        },
262                                        "bg_color": {
263                                          "type": "string",
264                                          "description": "The background color of the interface or layout."
265                                        }
266                                      }
267                                    },
268                                    "auth": {
269                                      "type": "object",
270                                      "properties": {
271                                        "show_header_auth": {
272                                          "type": "boolean",
273                                          "description": "Determines whether authentication options should be displayed in the header of the interface."
274                                        },
275                                        "show_footer_auth": {
276                                          "type": "boolean",
277                                          "description": "Determines whether authentication options should be displayed in the footer of the interface."
278                                        }
279                                      }
280                                    },
281                                    "palette": {
282                                      "type": "object",
283                                      "properties": {
284                                        "general_setting": {
285                                          "type": "object",
286                                          "properties": {
287                                            "theme": {
288                                              "type": "object",
289                                              "properties": {
290                                                "page_background": {
291                                                  "type": "string",
292                                                  "description": "The background color of the page."
293                                                },
294                                                "theme_accent": {
295                                                  "type": "string",
296                                                  "description": "The accent color used throughout the theme for highlights and accents."
297                                                }
298                                              }
299                                            },
300                                            "text": {
301                                              "type": "object",
302                                              "properties": {
303                                                "text_heading": {
304                                                  "type": "string",
305                                                  "description": "The color of heading text."
306                                                },
307                                                "text_body": {
308                                                  "type": "string",
309                                                  "description": "The color of body text."
310                                                },
311                                                "text_label": {
312                                                  "type": "string",
313                                                  "description": "The color of labels or secondary text."
314                                                },
315                                                "text_secondary": {
316                                                  "type": "string",
317                                                  "description": "The color of secondary text elements."
318                                                }
319                                              }
320                                            },
321                                            "button": {
322                                              "type": "object",
323                                              "properties": {
324                                                "button_primary": {
325                                                  "type": "string",
326                                                  "description": "The color of primary buttons."
327                                                },
328                                                "button_secondary": {
329                                                  "type": "string",
330                                                  "description": "The color of secondary buttons."
331                                                },
332                                                "button_link": {
333                                                  "type": "string",
334                                                  "description": "The color of hyperlink buttons."
335                                                }
336                                              }
337                                            },
338                                            "sale_discount": {
339                                              "type": "object",
340                                              "properties": {
341                                                "sale_badge_background": {
342                                                  "type": "string",
343                                                  "description": "The background color of sale badges."
344                                                },
345                                                "sale_badge_text": {
346                                                  "type": "string",
347                                                  "description": "The color of text on sale badges."
348                                                },
349                                                "sale_discount_text": {
350                                                  "type": "string",
351                                                  "description": "The color of text indicating discounts."
352                                                },
353                                                "sale_timer": {
354                                                  "type": "string",
355                                                  "description": "The color of the timer for sales."
356                                                }
357                                              }
358                                            },
359                                            "header": {
360                                              "type": "object",
361                                              "properties": {
362                                                "header_background": {
363                                                  "type": "string",
364                                                  "description": "The background color of the header."
365                                                },
366                                                "header_nav": {
367                                                  "type": "string",
368                                                  "description": "The color of navigation links in the header."
369                                                },
370                                                "header_icon": {
371                                                  "type": "string",
372                                                  "description": "The color of icons in the header."
373                                                }
374                                              }
375                                            },
376                                            "footer": {
377                                              "type": "object",
378                                              "properties": {
379                                                "footer_background": {
380                                                  "type": "string",
381                                                  "description": "The background color of the footer."
382                                                },
383                                                "footer_bottom_background": {
384                                                  "type": "string",
385                                                  "description": "The background color of the bottom section of the footer."
386                                                },
387                                                "footer_heading_text": {
388                                                  "type": "string",
389                                                  "description": "The color of heading text in the footer."
390                                                },
391                                                "footer_body_text": {
392                                                  "type": "string",
393                                                  "description": "The color of body text in the footer."
394                                                },
395                                                "footer_icon": {
396                                                  "type": "string",
397                                                  "description": "The color of icons in the footer."
398                                                }
399                                              }
400                                            }
401                                          }
402                                        },
403                                        "advance_setting": {
404                                          "type": "object",
405                                          "properties": {
406                                            "overlay_popup": {
407                                              "type": "object",
408                                              "properties": {
409                                                "dialog_backgroung": {
410                                                  "type": "string",
411                                                  "description": "The background color of dialog boxes in overlay popups."
412                                                },
413                                                "overlay": {
414                                                  "type": "string",
415                                                  "description": "The color of the overlay used in overlay popups."
416                                                }
417                                              }
418                                            },
419                                            "divider_stroke_highlight": {
420                                              "type": "object",
421                                              "properties": {
422                                                "divider_strokes": {
423                                                  "type": "string",
424                                                  "description": "The color of divider strokes."
425                                                },
426                                                "highlight": {
427                                                  "type": "string",
428                                                  "description": "The color used to highlight divider strokes."
429                                                }
430                                              }
431                                            },
432                                            "user_alerts": {
433                                              "type": "object",
434                                              "properties": {
435                                                "success_background": {
436                                                  "type": "string",
437                                                  "description": "The background color for success alerts."
438                                                },
439                                                "success_text": {
440                                                  "type": "string",
441                                                  "description": "The color of text in success alerts."
442                                                },
443                                                "error_background": {
444                                                  "type": "string",
445                                                  "description": "The background color for error alerts."
446                                                },
447                                                "error_text": {
448                                                  "type": "string",
449                                                  "description": "The color of text in error alerts."
450                                                },
451                                                "info_background": {
452                                                  "type": "string",
453                                                  "description": "The background color for informational alerts."
454                                                },
455                                                "info_text": {
456                                                  "type": "string",
457                                                  "description": "The color of text in informational alerts."
458                                                }
459                                              }
460                                            }
461                                          },
462                                          "description": "Colors of specific elements within the application facade."
463                                        }
464                                      }
465                                    },
466                                    "order_tracking": {
467                                      "type": "object",
468                                      "properties": {
469                                        "show_header": {
470                                          "type": "boolean",
471                                          "description": "Determines whether order tracking information should be displayed in the header of the interface."
472                                        },
473                                        "show_footer": {
474                                          "type": "boolean",
475                                          "description": "Determines whether order tracking information should be displayed in the footer of the interface."
476                                        }
477                                      }
478                                    },
479                                    "extension": {
480                                      "type": "object",
481                                      "description": "Additional settings or features that extend the functionality of the theme tracking system."
482                                    }
483                                  }
484                                }
485                              }
486                            },
487                            "custom": {
488                              "type": "object",
489                              "properties": {
490                                "header_bg_color": {
491                                  "type": "string",
492                                  "description": "Background color of the header."
493                                },
494                                "header_text_color": {
495                                  "type": "string",
496                                  "description": "Color of text in the header."
497                                },
498                                "header_border_color": {
499                                  "type": "string",
500                                  "description": "Color of borders in the header."
501                                },
502                                "header_icon_color": {
503                                  "type": "string",
504                                  "description": "Color of icons in the header."
505                                },
506                                "header_cart_notification_bg_color": {
507                                  "type": "string",
508                                  "description": "Background color of the cart notification in the header."
509                                },
510                                "header_cart_notification_text_color": {
511                                  "type": "string",
512                                  "description": "Color of text in the cart notification in the header."
513                                },
514                                "header_nav_hover_color": {
515                                  "type": "string",
516                                  "description": "Color of navigation links when hovered over in the header."
517                                },
518                                "button_primary_color": {
519                                  "type": "string",
520                                  "description": "Color of primary buttons."
521                                },
522                                "button_primary_label_color": {
523                                  "type": "string",
524                                  "description": "Color of labels/text on primary buttons."
525                                },
526                                "button_add_to_cart_color": {
527                                  "type": "string",
528                                  "description": "Color of 'Add to Cart' buttons."
529                                },
530                                "button_add_to_cart_label_color": {
531                                  "type": "string",
532                                  "description": "Color of labels/text on 'Add to Cart' buttons."
533                                },
534                                "button_secondary_color": {
535                                  "type": "string",
536                                  "description": "Color of secondary buttons."
537                                },
538                                "button_secondary_label_color": {
539                                  "type": "string",
540                                  "description": "Color of labels/text on secondary buttons."
541                                },
542                                "button_tertiary_color": {
543                                  "type": "string",
544                                  "description": "Color of tertiary buttons."
545                                },
546                                "button_tertiary_label_color": {
547                                  "type": "string",
548                                  "description": "Color of labels/text on tertiary buttons."
549                                },
550                                "button_tertiary_hover_color": {
551                                  "type": "string",
552                                  "description": "Background color of tertiary buttons when hovered over."
553                                },
554                                "button_tertiary_hover_text_color": {
555                                  "type": "string",
556                                  "description": "Color of text on tertiary buttons when hovered over."
557                                },
558                                "text_heading_link_color": {
559                                  "type": "string",
560                                  "description": "Color of links within headings."
561                                },
562                                "text_body_color": {
563                                  "type": "string",
564                                  "description": "Color of body text."
565                                },
566                                "text_price_color": {
567                                  "type": "string",
568                                  "description": "Color of regular price text."
569                                },
570                                "text_sale_price_color": {
571                                  "type": "string",
572                                  "description": "Color of sale price text."
573                                },
574                                "text_strikethrough_price_color": {
575                                  "type": "string",
576                                  "description": "Color of strikethrough price text."
577                                },
578                                "text_discount_color": {
579                                  "type": "string",
580                                  "description": "Color of discount text."
581                                },
582                                "footer_bg_color": {
583                                  "type": "string",
584                                  "description": "Background color of the footer."
585                                },
586                                "footer_text_color": {
587                                  "type": "string",
588                                  "description": "Color of text in the footer."
589                                },
590                                "footer_border_color": {
591                                  "type": "string",
592                                  "description": "Color of borders in the footer."
593                                },
594                                "footer_nav_hover_color": {
595                                  "type": "string",
596                                  "description": "Color of navigation links when hovered over in the footer."
597                                }
598                              }
599                            }
600                          }
601                        }
602                      }
603                    }
604                  },
605                  "current": {
606                    "type": "string"
607                  }
608                }
609              },
610              "description": "Theme configuration details"
611            },
612            "styles": {
613              "type": "object",
614              "description": "Styling details of theme"
615            },
616            "applied": {
617              "type": "boolean",
618              "description": "Theme is currently applied or not"
619            },
620            "created_at": {
621              "type": "string",
622              "description": "Timestamp when theme was created"
623            },
624            "is_private": {
625              "type": "boolean",
626              "description": "If the theme is private or not"
627            },
628            "theme_type": {
629              "type": "string",
630              "description": "Theme type being either Vue2 or React"
631            },
632            "updated_at": {
633              "type": "string",
634              "description": "When was the theme object last modified"
635            },
636            "application_id": {
637              "type": "string",
638              "description": "Application ID to which the theme belongs"
639            },
640            "template_theme_id": {
641              "type": "string",
642              "description": "Template ID of the theme"
643            },
644            "marketplace_theme_id": {
645              "type": "string",
646              "description": "Marketplace ID which has the theme configured"
647            }
648          }
649        }
650      }
651    }
652  }
653}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.249a4ccc-4765-4f09-a138-18f59d188747"
5    ],
6    "name": "theme",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1711959106089,
10    "id": "Zq2Pr57/GOmatrzqdisaJpQalUs0zmFC5VlFSL1uTbk=",
11    "category": "application"
12  },
13  "company_id": 61,
14  "application_id": "5d63686df2a4f7806b76bb32",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "font": {
21        "variants": {
22          "light": {
23            "name": "300",
24            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"
25          },
26          "regular": {
27            "name": "regular",
28            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"
29          },
30          "medium": {
31            "name": "500",
32            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"
33          },
34          "semi_bold": {
35            "name": "600",
36            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"
37          },
38          "bold": {
39            "name": "700",
40            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"
41          }
42        },
43        "family": "Poppins"
44      },
45      "config": {
46        "current": "Default",
47        "list": [
48          {
49            "name": "Default",
50            "global_config": {
51              "static": {
52                "props": {
53                  "colors": {
54                    "primary_color": "#7043f7",
55                    "secondary_color": "#02d1cb",
56                    "accent_color": "#FFFFFF",
57                    "link_color": "#7043f7",
58                    "button_secondary_color": "#000000",
59                    "bg_color": "#F8F8F8"
60                  },
61                  "auth": {
62                    "show_header_auth": true,
63                    "show_footer_auth": true
64                  },
65                  "palette": {
66                    "general_setting": {
67                      "theme": {
68                        "page_background": "#fff9f3",
69                        "theme_accent": "#bea5a9"
70                      },
71                      "text": {
72                        "text_heading": "#000507",
73                        "text_body": "#010e15",
74                        "text_label": "#35596c",
75                        "text_secondary": "#678391"
76                      },
77                      "button": {
78                        "button_primary": "#023047",
79                        "button_secondary": "#ffffff",
80                        "button_link": "#552531"
81                      },
82                      "sale_discount": {
83                        "sale_badge_background": "#f1faee",
84                        "sale_badge_text": "#410102",
85                        "sale_discount_text": "#1867b0",
86                        "sale_timer": "#e63946"
87                      },
88                      "header": {
89                        "header_background": "#ffffff",
90                        "header_nav": "#000507",
91                        "header_icon": "#000507"
92                      },
93                      "footer": {
94                        "footer_background": "#023047",
95                        "footer_bottom_background": "#022a3f",
96                        "footer_heading_text": "#f9f6f6",
97                        "footer_body_text": "#FFFFFF",
98                        "footer_icon": "#FFFFFF"
99                      }
100                    },
101                    "advance_setting": {
102                      "overlay_popup": {
103                        "dialog_backgroung": "#ffffff",
104                        "overlay": "#010e15"
105                      },
106                      "divider_stroke_highlight": {
107                        "divider_strokes": "#f2edee",
108                        "highlight": "#dfd2d4"
109                      },
110                      "user_alerts": {
111                        "success_background": "#e9f9ed",
112                        "success_text": "#1C958F",
113                        "error_background": "#fff5f5",
114                        "error_text": "#B24141",
115                        "info_background": "#fff359",
116                        "info_text": "#D28F51"
117                      }
118                    }
119                  },
120                  "order_tracking": {
121                    "show_header": true,
122                    "show_footer": true
123                  },
124                  "extension": {
125                    "header_top": [
126                      {
127                        "extension_id": "6242ba839a6e7a3be7078885",
128                        "extension_name": "Review and Rating",
129                        "config": {
130                          "extension_config_id": "6247050751895b2438909ee1",
131                          "extension_id": "6242ba839a6e7a3be7078885",
132                          "organization_id": "60b48f67ff08196f3d811cfa"
133                        },
134                        "template": {
135                          "slug": "",
136                          "display": "Floating Window",
137                          "restrict_page": [],
138                          "wrapper": "<div id=\"floating-window\"></div>",
139                          "_id": "65394bd3793b005167696b87"
140                        }
141                      }
142                    ],
143                    "header_bottom": [],
144                    "footer_top": [],
145                    "footer_bottom": []
146                  }
147                }
148              },
149              "custom": {
150                "props": {
151                  "header_icon_color": "#000000",
152                  "menu_position": "bottom",
153                  "artwork": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/11197/applications/60b8c8a67b0862f85a672571/theme/pictures/free/original/theme-image-1668580342482.jpeg",
154                  "enable_artwork": false,
155                  "footer_bg_color": "#792a2a",
156                  "footer_text_color": "#9f8484",
157                  "footer_border_color": "#a6e7bf",
158                  "footer_nav_hover_color": "#59e8b9",
159                  "menu_layout_desktop": "layout_3",
160                  "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/13619/applications/6426d6d07413f975950390fc/theme/pictures/free/original/theme-image-1680268022124.png",
161                  "logo_width": 774,
162                  "footer_description": "Astra is designed to create a seamless shopping experience for your customers. With a responsive layout and customizable options, you can showcase your products in a way that truly reflects your brand’s personality. The theme is optimized for speed and SEO, ensuring your website is not only visually appealing but also ranks well on search engines.",
163                  "logo_menu_alignment": "layout_4",
164                  "header_layout": "double",
165                  "section_margin_top": 89,
166                  "font_header": {
167                    "variants": {
168                      "light": {
169                        "name": "300",
170                        "file": "https://fonts.gstatic.com/s/playfairdisplay/v30/nuFvD-vYSZviVYUb_rj3ij__anPXJzDwcbmjWBN2PKdFvUDQZNLo_U2r.ttf"
171                      },
172                      "regular": {
173                        "name": "regular",
174                        "file": "https://fonts.gstatic.com/s/playfairdisplay/v30/nuFvD-vYSZviVYUb_rj3ij__anPXJzDwcbmjWBN2PKdFvUDQZNLo_U2r.ttf"
175                      },
176                      "medium": {
177                        "name": "500",
178                        "file": "https://fonts.gstatic.com/s/playfairdisplay/v30/nuFvD-vYSZviVYUb_rj3ij__anPXJzDwcbmjWBN2PKd3vUDQZNLo_U2r.ttf"
179                      },
180                      "semi_bold": {
181                        "name": "600",
182                        "file": "https://fonts.gstatic.com/s/playfairdisplay/v30/nuFvD-vYSZviVYUb_rj3ij__anPXJzDwcbmjWBN2PKebukDQZNLo_U2r.ttf"
183                      },
184                      "bold": {
185                        "name": "700",
186                        "file": "https://fonts.gstatic.com/s/playfairdisplay/v30/nuFvD-vYSZviVYUb_rj3ij__anPXJzDwcbmjWBN2PKeiukDQZNLo_U2r.ttf"
187                      }
188                    },
189                    "family": "Playfair Display"
190                  },
191                  "font_body": {
192                    "variants": {
193                      "light": {
194                        "name": "300",
195                        "file": "https://fonts.gstatic.com/s/worksans/v18/QGY_z_wNahGAdqQ43RhVcIgYT2Xz5u32KxfXNigDp6_cOyA.ttf"
196                      },
197                      "regular": {
198                        "name": "regular",
199                        "file": "https://fonts.gstatic.com/s/worksans/v18/QGY_z_wNahGAdqQ43RhVcIgYT2Xz5u32K0nXNigDp6_cOyA.ttf"
200                      },
201                      "medium": {
202                        "name": "500",
203                        "file": "https://fonts.gstatic.com/s/worksans/v18/QGY_z_wNahGAdqQ43RhVcIgYT2Xz5u32K3vXNigDp6_cOyA.ttf"
204                      },
205                      "semi_bold": {
206                        "name": "600",
207                        "file": "https://fonts.gstatic.com/s/worksans/v18/QGY_z_wNahGAdqQ43RhVcIgYT2Xz5u32K5fQNigDp6_cOyA.ttf"
208                      },
209                      "bold": {
210                        "name": "700",
211                        "file": "https://fonts.gstatic.com/s/worksans/v18/QGY_z_wNahGAdqQ43RhVcIgYT2Xz5u32K67QNigDp6_cOyA.ttf"
212                      }
213                    },
214                    "family": "Work Sans"
215                  },
216                  "section_margin_bottom": 16,
217                  "payments_logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/company/13619/applications/6426d6d07413f975950390fc/theme/pictures/free/original/theme-image-1680268777553.png"
218                }
219              }
220            },
221            "page": [
222              {
223                "settings": {
224                  "props": {
225                    "extension": {
226                      "below_price_component": [],
227                      "below_product_info": [
228                        {
229                          "extension_id": "63182762e05785063b42a55c",
230                          "extension_name": "Size Comparison",
231                          "config": {
232                            "extension_config_id": "632468dd97ad99c4fb051be3",
233                            "extension_id": "63182762e05785063b42a55c",
234                            "organization_id": "60b48f67ff08196f3d811cfa"
235                          },
236                          "template": {
237                            "restrict_page": [
238                              "product"
239                            ],
240                            "_id": "632468dd97ad99b162051be4",
241                            "display": "Size Comparison Widget",
242                            "wrapper": "<div id=\"ext-size-comparison-view\"></div>",
243                            "slug": ""
244                          }
245                        },
246                        {
247                          "extension_id": "621ce569cb91ec40e4d6c019",
248                          "extension_name": "Product Recommendation",
249                          "config": {
250                            "extension_config_id": "62330effd4e498a1acfdaaa6",
251                            "extension_id": "621ce569cb91ec40e4d6c019",
252                            "organization_id": "60b48f67ff08196f3d811cfa"
253                          },
254                          "template": {
255                            "slug": "",
256                            "display": "Up Sell",
257                            "restrict_page": [],
258                            "wrapper": "<div id=\"ext-product-recommendation_up-sell\"></div>",
259                            "_id": "65488918bbeb64db7001798f"
260                          }
261                        }
262                      ],
263                      "product_description_bottom": [
264                        {
265                          "extension_id": "6242ba839a6e7a3be7078885",
266                          "extension_name": "Review and Rating",
267                          "config": {
268                            "extension_config_id": "6247050751895b2438909ee1",
269                            "extension_id": "6242ba839a6e7a3be7078885",
270                            "organization_id": "60b48f67ff08196f3d811cfa"
271                          },
272                          "template": {
273                            "slug": "",
274                            "display": "rating-review",
275                            "restrict_page": [],
276                            "wrapper": "<div id=\"review-list\"></div>",
277                            "_id": "6247051419b99b80e3ad4e85"
278                          }
279                        }
280                      ]
281                    },
282                    "badge_url_1": "",
283                    "badge_url_2": "",
284                    "badge_url_3": "",
285                    "badge_url_4": "",
286                    "badge_url_5": ""
287                  }
288                },
289                "page": "product-description"
290              },
291              {
292                "settings": {
293                  "props": {
294                    "continue_as_guest": true,
295                    "share_cart": false,
296                    "staff_selection": false,
297                    "checkout_mode": false,
298                    "gst": false
299                  }
300                },
301                "page": "cart-landing"
302              },
303              {
304                "settings": {
305                  "props": {
306                    "extension": {
307                      "below_price_breakup": [
308                        {
309                          "extension_id": "6242ba839a6e7a3be7078885",
310                          "extension_name": "Review and Rating",
311                          "config": {
312                            "extension_config_id": "6247050751895b2438909ee1",
313                            "extension_id": "6242ba839a6e7a3be7078885",
314                            "organization_id": "60b48f67ff08196f3d811cfa"
315                          },
316                          "template": {
317                            "slug": "",
318                            "display": "application-review-modal",
319                            "restrict_page": [],
320                            "wrapper": "<div id=\"application-review-modal\"></div>",
321                            "_id": "63f4b4904adb0bbd79ddff9c"
322                          }
323                        }
324                      ],
325                      "below_shipment_list": []
326                    }
327                  }
328                },
329                "page": "order-status"
330              }
331            ]
332          }
333        ]
334      },
335      "_id": "65398b847d5fcf80c6693932",
336      "applied": false,
337      "is_private": false,
338      "tags": [
339        "ASTRA"
340      ],
341      "theme_type": "vue2",
342      "application_id": "5d63686df2a4f7806b76bb32",
343      "styles": {},
344      "marketplace_theme_id": "65311f331552c75d7e02f0de",
345      "template_theme_id": "6531220e3993817e53c3b3e4",
346      "name": "Updated copy of Astra",
347      "version": "1.0.22",
348      "meta": {
349        "payment": {
350          "is_paid": false,
351          "amount": 0
352        },
353        "description": "Presenting Astra, Fynd's newest e-commerce website theme, packed with a wide range of features that allow you to create a stunning online store and enhance your e-commerce skills.",
354        "industry": [
355          "Clothing",
356          "Home and decor",
357          "Jewelry and accessories"
358        ],
359        "release": {
360          "notes": "<div class=\"p-rich_text_section\"><strong data-stringify-type=\"bold\">Release Note - Version 1.0.22<br /></strong><br />We're excited to introduce some fantastic new features and improvements in this latest release. Here's what you can expect:<br /><strong data-stringify-type=\"bold\">New Feature:</strong></div>\n<ol class=\"p-rich_text_list p-rich_text_list__ordered\" data-stringify-type=\"ordered-list\" data-indent=\"0\" data-border=\"0\">\n<li data-stringify-indent=\"0\" data-stringify-border=\"0\"><strong data-stringify-type=\"bold\">Size Selection Styles:</strong></li>\n</ol>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"1\" data-border=\"0\">\n<li data-stringify-indent=\"1\" data-stringify-border=\"0\">Now, you have even more control over how your customers choose sizes for products with two distinct styles:</li>\n</ul>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"2\" data-border=\"0\">\n<li data-stringify-indent=\"2\" data-stringify-border=\"0\"><strong data-stringify-type=\"bold\">Dropdown Style:</strong>&nbsp;Enhance the user experience with a dropdown menu for selecting sizes. It provides an organized and clutter-free way for customers to pick the right size.</li>\n<li data-stringify-indent=\"2\" data-stringify-border=\"0\"><strong data-stringify-type=\"bold\">Block Style:</strong>&nbsp;Opt for the block style to present size options in an easy-to-read, visually appealing grid format. Customers can quickly identify and choose the size that suits them best.</li>\n</ul>\n<div class=\"p-rich_text_section\"><strong data-stringify-type=\"bold\">Improvements:<br /><br /></strong><strong data-stringify-type=\"bold\">1. Mobile Image Quality Improved:</strong></div>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"0\" data-border=\"0\">\n<li data-stringify-indent=\"0\" data-stringify-border=\"0\">We've enhanced the image quality for mobile devices, ensuring that your visuals look sharper and more stunning than ever on smaller screens. Your content will shine, whether your users are on a smartphone or tablet.</li>\n</ul>\n<div class=\"p-rich_text_section\"><strong data-stringify-type=\"bold\">2. Image Lazy Loading Feature:</strong></div>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"0\" data-border=\"0\">\n<li data-stringify-indent=\"0\" data-stringify-border=\"0\">Introducing image lazy loading, a performance optimization that reduces page loading times. Images will now load on-demand, as users scroll down your pages, improving the overall user experience and saving bandwidth.</li>\n</ul>\n<div class=\"p-rich_text_section\"><strong data-stringify-type=\"bold\">3. Minor Fixes for the Theme:</strong></div>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"0\" data-border=\"0\">\n<li data-stringify-indent=\"0\" data-stringify-border=\"0\">We've listened to your feedback and made several minor fixes to the theme to ensure a smoother and more seamless experience. These tweaks address various user interface and user experience improvements.</li>\n</ul>\n<div class=\"p-rich_text_section\">These updates aim to elevate your website's aesthetics, user-friendliness, and overall performance.</div>",
361          "version": "1.0.22"
362        },
363        "images": {
364          "desktop": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/svAn0jCwz-images_desktop.png",
365          "mobile": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/TpLehnrIW-images_mobile.png"
366        },
367        "slug": "astra",
368        "name": "Astra"
369      },
370      "created_at": "2023-10-25T21:41:24.581Z",
371      "updated_at": "2024-02-06T09:12:54.344Z",
372      "company_id": 61,
373      "global_sections": []
374    }
375  }
376}

application/theme/update/v1

This event is triggered when theme is updated

Payload
Properties
application_id
array|string
Required
Application ID(Sales Channel) 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 Style configuration for theme.
Properties
_id
string
Unique theme ID
font
object
Font configurations
Properties
family
string
The font family.
variants
object
Font variants available for the font family.
Properties
bold
object
The bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
light
object
The light variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
medium
object
The medium variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
regular
object
The regular variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
semi_bold
object
The semi-bold variant of the font.
Properties
file
string
File path or URL for the font file.
name
string
Name of the font variant.
meta
object
Meta configurations of a theme
name
string
Name of the theme
tags
array of string
Tags for the theme
config
object
Theme configuration details
Properties
list
array of object
An array of items.
Array of Properties
name
string
Name of the item.
page
array of object
An array of pages.
Array of Properties
settings
object
Settings for the page.
Properties
props
object
Properties for the page.
Properties
page
string
Name of the page.
styles
object
Styling details of theme
applied
boolean
Theme is currently applied or not
created_at
string
Timestamp when theme was created
is_private
boolean
If the theme is private or not
theme_type
string
Theme type being either Vue2 or React
updated_at
string
When was the theme object last modified
application_id
string
Required
Application ID to which the theme belongs
template_theme_id
string
Template theme ID on which the theme was created
marketplace_theme_id
string
Marketplace theme ID on which the theme was created
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 ID(Sales Channel) 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            "application_id"
84          ],
85          "description": "Theme Style configuration for theme.",
86          "properties": {
87            "_id": {
88              "type": "string",
89              "description": "Unique theme ID"
90            },
91            "font": {
92              "type": "object",
93              "properties": {
94                "family": {
95                  "type": "string",
96                  "description": "The font family."
97                },
98                "variants": {
99                  "type": "object",
100                  "description": "Font variants available for the font family.",
101                  "properties": {
102                    "bold": {
103                      "type": "object",
104                      "description": "The bold variant of the font.",
105                      "properties": {
106                        "file": {
107                          "type": "string",
108                          "description": "File path or URL for the font file."
109                        },
110                        "name": {
111                          "type": "string",
112                          "description": "Name of the font variant."
113                        }
114                      }
115                    },
116                    "light": {
117                      "type": "object",
118                      "description": "The light variant of the font.",
119                      "properties": {
120                        "file": {
121                          "type": "string",
122                          "description": "File path or URL for the font file."
123                        },
124                        "name": {
125                          "type": "string",
126                          "description": "Name of the font variant."
127                        }
128                      }
129                    },
130                    "medium": {
131                      "type": "object",
132                      "description": "The medium variant of the font.",
133                      "properties": {
134                        "file": {
135                          "type": "string",
136                          "description": "File path or URL for the font file."
137                        },
138                        "name": {
139                          "type": "string",
140                          "description": "Name of the font variant."
141                        }
142                      }
143                    },
144                    "regular": {
145                      "type": "object",
146                      "description": "The regular variant of the font.",
147                      "properties": {
148                        "file": {
149                          "type": "string",
150                          "description": "File path or URL for the font file."
151                        },
152                        "name": {
153                          "type": "string",
154                          "description": "Name of the font variant."
155                        }
156                      }
157                    },
158                    "semi_bold": {
159                      "type": "object",
160                      "description": "The semi-bold variant of the font.",
161                      "properties": {
162                        "file": {
163                          "type": "string",
164                          "description": "File path or URL for the font file."
165                        },
166                        "name": {
167                          "type": "string",
168                          "description": "Name of the font variant."
169                        }
170                      }
171                    }
172                  }
173                }
174              },
175              "description": "Font configurations"
176            },
177            "meta": {
178              "type": "object",
179              "description": "Meta configurations of a theme"
180            },
181            "name": {
182              "type": "string",
183              "description": "Name of the theme"
184            },
185            "tags": {
186              "type": "array",
187              "description": "Tags for the theme",
188              "items": {
189                "type": "string",
190                "description": "Details of third party scripts that will get injected in theme"
191              }
192            },
193            "config": {
194              "type": "object",
195              "properties": {
196                "list": {
197                  "type": "array",
198                  "description": "An array of items.",
199                  "items": {
200                    "type": "object",
201                    "properties": {
202                      "name": {
203                        "type": "string",
204                        "description": "Name of the item."
205                      },
206                      "page": {
207                        "type": "array",
208                        "description": "An array of pages.",
209                        "items": {
210                          "type": "object",
211                          "properties": {
212                            "settings": {
213                              "type": "object",
214                              "description": "Settings for the page.",
215                              "properties": {
216                                "props": {
217                                  "type": "object",
218                                  "description": "Properties for the page.",
219                                  "properties": {
220                                    "page": {
221                                      "type": "string",
222                                      "description": "Name of the page."
223                                    }
224                                  }
225                                }
226                              }
227                            }
228                          }
229                        },
230                        "global_config": {
231                          "type": "object",
232                          "properties": {
233                            "static": {
234                              "type": "object",
235                              "properties": {
236                                "props": {
237                                  "type": "object",
238                                  "properties": {
239                                    "colors": {
240                                      "type": "object",
241                                      "properties": {
242                                        "primary_color": {
243                                          "type": "string",
244                                          "description": "The main color used for branding and primary elements."
245                                        },
246                                        "secondary_color": {
247                                          "type": "string",
248                                          "description": "A supporting color used alongside the primary color for additional design elements."
249                                        },
250                                        "accent_color": {
251                                          "type": "string",
252                                          "description": "A color used to highlight specific elements and create visual interest."
253                                        },
254                                        "link_color": {
255                                          "type": "string",
256                                          "description": "The color used for hyperlinks and interactive elements such as buttons."
257                                        },
258                                        "button_secondary_color": {
259                                          "type": "string",
260                                          "description": "An alternate color option for buttons, typically used in conjunction with the primary button color."
261                                        },
262                                        "bg_color": {
263                                          "type": "string",
264                                          "description": "The background color of the interface or layout."
265                                        }
266                                      }
267                                    },
268                                    "auth": {
269                                      "type": "object",
270                                      "properties": {
271                                        "show_header_auth": {
272                                          "type": "boolean",
273                                          "description": "Determines whether authentication options should be displayed in the header of the interface."
274                                        },
275                                        "show_footer_auth": {
276                                          "type": "boolean",
277                                          "description": "Determines whether authentication options should be displayed in the footer of the interface."
278                                        }
279                                      }
280                                    },
281                                    "palette": {
282                                      "type": "object",
283                                      "properties": {
284                                        "general_setting": {
285                                          "type": "object",
286                                          "properties": {
287                                            "theme": {
288                                              "type": "object",
289                                              "properties": {
290                                                "page_background": {
291                                                  "type": "string",
292                                                  "description": "The background color of the page."
293                                                },
294                                                "theme_accent": {
295                                                  "type": "string",
296                                                  "description": "The accent color used throughout the theme for highlights and accents."
297                                                }
298                                              }
299                                            },
300                                            "text": {
301                                              "type": "object",
302                                              "properties": {
303                                                "text_heading": {
304                                                  "type": "string",
305                                                  "description": "The color of heading text."
306                                                },
307                                                "text_body": {
308                                                  "type": "string",
309                                                  "description": "The color of body text."
310                                                },
311                                                "text_label": {
312                                                  "type": "string",
313                                                  "description": "The color of labels or secondary text."
314                                                },
315                                                "text_secondary": {
316                                                  "type": "string",
317                                                  "description": "The color of secondary text elements."
318                                                }
319                                              }
320                                            },
321                                            "button": {
322                                              "type": "object",
323                                              "properties": {
324                                                "button_primary": {
325                                                  "type": "string",
326                                                  "description": "The color of primary buttons."
327                                                },
328                                                "button_secondary": {
329                                                  "type": "string",
330                                                  "description": "The color of secondary buttons."
331                                                },
332                                                "button_link": {
333                                                  "type": "string",
334                                                  "description": "The color of hyperlink buttons."
335                                                }
336                                              }
337                                            },
338                                            "sale_discount": {
339                                              "type": "object",
340                                              "properties": {
341                                                "sale_badge_background": {
342                                                  "type": "string",
343                                                  "description": "The background color of sale badges."
344                                                },
345                                                "sale_badge_text": {
346                                                  "type": "string",
347                                                  "description": "The color of text on sale badges."
348                                                },
349                                                "sale_discount_text": {
350                                                  "type": "string",
351                                                  "description": "The color of text indicating discounts."
352                                                },
353                                                "sale_timer": {
354                                                  "type": "string",
355                                                  "description": "The color of the timer for sales."
356                                                }
357                                              }
358                                            },
359                                            "header": {
360                                              "type": "object",
361                                              "properties": {
362                                                "header_background": {
363                                                  "type": "string",
364                                                  "description": "The background color of the header."
365                                                },
366                                                "header_nav": {
367                                                  "type": "string",
368                                                  "description": "The color of navigation links in the header."
369                                                },
370                                                "header_icon": {
371                                                  "type": "string",
372                                                  "description": "The color of icons in the header."
373                                                }
374                                              }
375                                            },
376                                            "footer": {
377                                              "type": "object",
378                                              "properties": {
379                                                "footer_background": {
380                                                  "type": "string",
381                                                  "description": "The background color of the footer."
382                                                },
383                                                "footer_bottom_background": {
384                                                  "type": "string",
385                                                  "description": "The background color of the bottom section of the footer."
386                                                },
387                                                "footer_heading_text": {
388                                                  "type": "string",
389                                                  "description": "The color of heading text in the footer."
390                                                },
391                                                "footer_body_text": {
392                                                  "type": "string",
393                                                  "description": "The color of body text in the footer."
394                                                },
395                                                "footer_icon": {
396                                                  "type": "string",
397                                                  "description": "The color of icons in the footer."
398                                                }
399                                              }
400                                            }
401                                          }
402                                        },
403                                        "advance_setting": {
404                                          "type": "object",
405                                          "properties": {
406                                            "overlay_popup": {
407                                              "type": "object",
408                                              "properties": {
409                                                "dialog_backgroung": {
410                                                  "type": "string",
411                                                  "description": "The background color of dialog boxes in overlay popups."
412                                                },
413                                                "overlay": {
414                                                  "type": "string",
415                                                  "description": "The color of the overlay used in overlay popups."
416                                                }
417                                              }
418                                            },
419                                            "divider_stroke_highlight": {
420                                              "type": "object",
421                                              "properties": {
422                                                "divider_strokes": {
423                                                  "type": "string",
424                                                  "description": "The color of divider strokes."
425                                                },
426                                                "highlight": {
427                                                  "type": "string",
428                                                  "description": "The color used to highlight divider strokes."
429                                                }
430                                              }
431                                            },
432                                            "user_alerts": {
433                                              "type": "object",
434                                              "properties": {
435                                                "success_background": {
436                                                  "type": "string",
437                                                  "description": "The background color for success alerts."
438                                                },
439                                                "success_text": {
440                                                  "type": "string",
441                                                  "description": "The color of text in success alerts."
442                                                },
443                                                "error_background": {
444                                                  "type": "string",
445                                                  "description": "The background color for error alerts."
446                                                },
447                                                "error_text": {
448                                                  "type": "string",
449                                                  "description": "The color of text in error alerts."
450                                                },
451                                                "info_background": {
452                                                  "type": "string",
453                                                  "description": "The background color for informational alerts."
454                                                },
455                                                "info_text": {
456                                                  "type": "string",
457                                                  "description": "The color of text in informational alerts."
458                                                }
459                                              }
460                                            }
461                                          },
462                                          "description": "Colors of specific elements within the application facade."
463                                        }
464                                      }
465                                    },
466                                    "order_tracking": {
467                                      "type": "object",
468                                      "properties": {
469                                        "show_header": {
470                                          "type": "boolean",
471                                          "description": "Determines whether order tracking information should be displayed in the header of the interface."
472                                        },
473                                        "show_footer": {
474                                          "type": "boolean",
475                                          "description": "Determines whether order tracking information should be displayed in the footer of the interface."
476                                        }
477                                      }
478                                    },
479                                    "extension": {
480                                      "type": "object",
481                                      "description": "Additional settings or features that extend the functionality of the theme tracking system."
482                                    }
483                                  }
484                                }
485                              }
486                            },
487                            "custom": {
488                              "type": "object",
489                              "properties": {
490                                "header_bg_color": {
491                                  "type": "string",
492                                  "description": "Background color of the header."
493                                },
494                                "header_text_color": {
495                                  "type": "string",
496                                  "description": "Color of text in the header."
497                                },
498                                "header_border_color": {
499                                  "type": "string",
500                                  "description": "Color of borders in the header."
501                                },
502                                "header_icon_color": {
503                                  "type": "string",
504                                  "description": "Color of icons in the header."
505                                },
506                                "header_cart_notification_bg_color": {
507                                  "type": "string",
508                                  "description": "Background color of the cart notification in the header."
509                                },
510                                "header_cart_notification_text_color": {
511                                  "type": "string",
512                                  "description": "Color of text in the cart notification in the header."
513                                },
514                                "header_nav_hover_color": {
515                                  "type": "string",
516                                  "description": "Color of navigation links when hovered over in the header."
517                                },
518                                "button_primary_color": {
519                                  "type": "string",
520                                  "description": "Color of primary buttons."
521                                },
522                                "button_primary_label_color": {
523                                  "type": "string",
524                                  "description": "Color of labels/text on primary buttons."
525                                },
526                                "button_add_to_cart_color": {
527                                  "type": "string",
528                                  "description": "Color of 'Add to Cart' buttons."
529                                },
530                                "button_add_to_cart_label_color": {
531                                  "type": "string",
532                                  "description": "Color of labels/text on 'Add to Cart' buttons."
533                                },
534                                "button_secondary_color": {
535                                  "type": "string",
536                                  "description": "Color of secondary buttons."
537                                },
538                                "button_secondary_label_color": {
539                                  "type": "string",
540                                  "description": "Color of labels/text on secondary buttons."
541                                },
542                                "button_tertiary_color": {
543                                  "type": "string",
544                                  "description": "Color of tertiary buttons."
545                                },
546                                "button_tertiary_label_color": {
547                                  "type": "string",
548                                  "description": "Color of labels/text on tertiary buttons."
549                                },
550                                "button_tertiary_hover_color": {
551                                  "type": "string",
552                                  "description": "Background color of tertiary buttons when hovered over."
553                                },
554                                "button_tertiary_hover_text_color": {
555                                  "type": "string",
556                                  "description": "Color of text on tertiary buttons when hovered over."
557                                },
558                                "text_heading_link_color": {
559                                  "type": "string",
560                                  "description": "Color of links within headings."
561                                },
562                                "text_body_color": {
563                                  "type": "string",
564                                  "description": "Color of body text."
565                                },
566                                "text_price_color": {
567                                  "type": "string",
568                                  "description": "Color of regular price text."
569                                },
570                                "text_sale_price_color": {
571                                  "type": "string",
572                                  "description": "Color of sale price text."
573                                },
574                                "text_strikethrough_price_color": {
575                                  "type": "string",
576                                  "description": "Color of strikethrough price text."
577                                },
578                                "text_discount_color": {
579                                  "type": "string",
580                                  "description": "Color of discount text."
581                                },
582                                "footer_bg_color": {
583                                  "type": "string",
584                                  "description": "Background color of the footer."
585                                },
586                                "footer_text_color": {
587                                  "type": "string",
588                                  "description": "Color of text in the footer."
589                                },
590                                "footer_border_color": {
591                                  "type": "string",
592                                  "description": "Color of borders in the footer."
593                                },
594                                "footer_nav_hover_color": {
595                                  "type": "string",
596                                  "description": "Color of navigation links when hovered over in the footer."
597                                }
598                              }
599                            }
600                          }
601                        }
602                      }
603                    }
604                  },
605                  "current": {
606                    "type": "string"
607                  }
608                }
609              },
610              "description": "Theme configuration details"
611            },
612            "styles": {
613              "type": "object",
614              "description": "Styling details of theme"
615            },
616            "applied": {
617              "type": "boolean",
618              "description": "Theme is currently applied or not"
619            },
620            "created_at": {
621              "type": "string",
622              "description": "Timestamp when theme was created"
623            },
624            "is_private": {
625              "type": "boolean",
626              "description": "If the theme is private or not"
627            },
628            "theme_type": {
629              "type": "string",
630              "description": "Theme type being either Vue2 or React"
631            },
632            "updated_at": {
633              "type": "string",
634              "description": "When was the theme object last modified"
635            },
636            "application_id": {
637              "type": "string",
638              "description": "Application ID to which the theme belongs"
639            },
640            "template_theme_id": {
641              "type": "string",
642              "description": "Template theme ID on which the theme was created"
643            },
644            "marketplace_theme_id": {
645              "type": "string",
646              "description": "Marketplace theme ID on which the theme was created"
647            }
648          }
649        }
650      }
651    }
652  }
653}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "blitzkrieg.4dba69d2-90f3-464d-9c1f-47c36765efd9"
5    ],
6    "name": "theme",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711617918578,
10    "id": "SYyplnPxDndGpL19vhs4i3KtPfbR7IIkCsuecEjA4s0=",
11    "category": "application"
12  },
13  "company_id": 3874,
14  "application_id": "65ebf1b676b65eec1cf4b362",
15  "contains": [
16    "theme"
17  ],
18  "payload": {
19    "theme": {
20      "font": {
21        "family": "Poppins",
22        "variants": {
23          "light": {
24            "name": "300",
25            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLDz8V1tvFP-KUEg.ttf"
26          },
27          "regular": {
28            "name": "regular",
29            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiEyp8kv8JHgFVrFJDUc1NECPY.ttf"
30          },
31          "medium": {
32            "name": "500",
33            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLGT9V1tvFP-KUEg.ttf"
34          },
35          "semi_bold": {
36            "name": "600",
37            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLEj6V1tvFP-KUEg.ttf"
38          },
39          "bold": {
40            "name": "700",
41            "file": "https://fonts.gstatic.com/s/poppins/v9/pxiByp8kv8JHgFVrLCz7V1tvFP-KUEg.ttf"
42          }
43        }
44      },
45      "config": {
46        "current": "Default",
47        "list": [
48          {
49            "name": "Default",
50            "global_config": {
51              "static": {
52                "props": {
53                  "colors": {
54                    "primary_color": "#000000",
55                    "secondary_color": "#000000",
56                    "accent_color": "#000000",
57                    "link_color": "#4499FF",
58                    "button_secondary_color": "#000000",
59                    "bg_color": "#F8F8F8"
60                  },
61                  "auth": {
62                    "show_header_auth": true,
63                    "show_footer_auth": true
64                  },
65                  "palette": {
66                    "general_setting": {
67                      "theme": {
68                        "page_background": "#f6fafb",
69                        "theme_accent": "#16b3aa"
70                      },
71                      "text": {
72                        "text_heading": "#121111",
73                        "text_body": "#15243a",
74                        "text_label": "#363f4d",
75                        "text_secondary": "#505b6b"
76                      },
77                      "button": {
78                        "button_primary": "#080808",
79                        "button_secondary": "#faf4f4",
80                        "button_link": "#15243a"
81                      },
82                      "sale_discount": {
83                        "sale_badge_background": "#0a0a0a",
84                        "sale_badge_text": "#ffffff",
85                        "sale_discount_text": "#000000",
86                        "sale_timer": "#000000"
87                      },
88                      "header": {
89                        "header_background": "#f6fafb",
90                        "header_nav": "#15243a",
91                        "header_icon": "#000000"
92                      },
93                      "footer": {
94                        "footer_background": "#e6f1f3",
95                        "footer_bottom_background": "#e6f1f3",
96                        "footer_heading_text": "#000000",
97                        "footer_body_text": "#000000",
98                        "footer_icon": "#000000"
99                      }
100                    },
101                    "advance_setting": {
102                      "overlay_popup": {
103                        "dialog_backgroung": "#FFFFFF",
104                        "overlay": "#f2f2f2"
105                      },
106                      "divider_stroke_highlight": {
107                        "divider_strokes": "#D4D1D1",
108                        "highlight": "#EDECE9"
109                      },
110                      "user_alerts": {
111                        "success_background": "#C2DBC9",
112                        "success_text": "#28b800",
113                        "error_background": "#a80b0b",
114                        "error_text": "#B24141",
115                        "info_background": "#EBD3BC",
116                        "info_text": "#D28F51"
117                      }
118                    }
119                  },
120                  "extension": {
121                    "header_top": [
122                      {
123                        "extension_id": "621ce569cb91ec40e4d6c019",
124                        "extension_name": "Product Recommendation",
125                        "config": {
126                          "extension_config_id": "62330effd4e498a1acfdaaa6",
127                          "extension_id": "621ce569cb91ec40e4d6c019",
128                          "organization_id": "60b48f67ff08196f3d811cfa"
129                        },
130                        "template": {
131                          "slug": "",
132                          "display": "Trending Products With Brand and Gender",
133                          "restrict_page": [],
134                          "wrapper": "<div id=\"ext-product-recommendation_product-trending-brand-gender\"></div>",
135                          "_id": "65cb4509ef62f29e6b41c1a4"
136                        }
137                      }
138                    ],
139                    "header_bottom": [],
140                    "footer_top": [],
141                    "footer_bottom": []
142                  },
143                  "order_tracking": {
144                    "show_header": true,
145                    "show_footer": true
146                  }
147                }
148              },
149              "custom": {
150                "props": {
151                  "header_bg_color": "#FFFFFF",
152                  "header_text_color": "#EB16EB",
153                  "header_border_color": "#e1e1e1",
154                  "header_icon_color": "#DE3636",
155                  "header_cart_notification_bg_color": "#000000",
156                  "header_cart_notification_text_color": "#ffffff",
157                  "header_nav_hover_color": "#999999",
158                  "button_primary_color": "#D827EB",
159                  "button_primary_label_color": "#F42971",
160                  "button_add_to_cart_color": "#0BE9CA",
161                  "button_add_to_cart_label_color": "#DF0EDA",
162                  "button_secondary_color": "#101311",
163                  "button_secondary_label_color": "#1818F1",
164                  "button_tertiary_color": "#222020",
165                  "button_tertiary_label_color": "#2910E9",
166                  "button_tertiary_hover_color": "#000000",
167                  "button_tertiary_hover_text_color": "#ffffff",
168                  "text_heading_link_color": "#1C1A1C",
169                  "text_body_color": "#EB0ED5",
170                  "text_price_color": "#25ED2D",
171                  "text_sale_price_color": "#E4B713",
172                  "text_strikethrough_price_color": "#EF1D1D",
173                  "text_discount_color": "#25F61B",
174                  "footer_bg_color": "#ffffff",
175                  "footer_text_color": "#B6A2A2",
176                  "footer_border_color": "#000000",
177                  "footer_nav_hover_color": "#16b3aa",
178                  "disable_cart": false,
179                  "is_menu_below_logo": false,
180                  "menu_position": "left",
181                  "tax_label_color": "#DADE1B",
182                  "footer_title_1": "CUSTOMER SERVICE",
183                  "footer_title_2": "ABOUT THE COMPANY",
184                  "footer_title_3": "Site Terms",
185                  "contact": "1111111111",
186                  "support_mail": "test@example.com",
187                  "footer_margin_top": 10,
188                  "footer_margin_bottom": 4,
189                  "store_locator": true,
190                  "facebook_link": "https://www.facebook.com/SteveMaddenIndia",
191                  "instagram_link": "https://www.instagram.com/stevemaddenindia",
192                  "youtube_link": "https://www.youtube.com/channel/UC3HFUKw6qNxsIDs6wh-vTFg",
193                  "redirect_link": "https://steve-madden.hostx1.de",
194                  "slide_link_1": "",
195                  "slide_link_2": "https://steve-madden.hostx1.de/wishlist",
196                  "strip_description": "End of Season Sale is live. Get addi. 10% off on orders above 4999!",
197                  "url_text_1": "Explore now.",
198                  "url_text_2": "Track your Orders & Returns here",
199                  "enable_announcement_bar": true,
200                  "font_header": {
201                    "variants": {
202                      "light": {
203                        "name": "300",
204                        "file": "https://fonts.gstatic.com/s/aronesans/v4/TUZezwhrmbFp0Srr_tH6fv6RcUejHO_u7GF5aXfv-U2QzBLF6gslWn_9DW03no5mBF4.ttf"
205                      },
206                      "regular": {
207                        "name": "regular",
208                        "file": "https://fonts.gstatic.com/s/aronesans/v4/TUZezwhrmbFp0Srr_tH6fv6RcUejHO_u7GF5aXfv-U2QzBLF6gslWn_9DW03no5mBF4.ttf"
209                      },
210                      "medium": {
211                        "name": "500",
212                        "file": "https://fonts.gstatic.com/s/aronesans/v4/TUZezwhrmbFp0Srr_tH6fv6RcUejHO_u7GF5aXfv-U2QzBLF6gslWk39DW03no5mBF4.ttf"
213                      },
214                      "semi_bold": {
215                        "name": "600",
216                        "file": "https://fonts.gstatic.com/s/aronesans/v4/TUZezwhrmbFp0Srr_tH6fv6RcUejHO_u7GF5aXfv-U2QzBLF6gslWqH6DW03no5mBF4.ttf"
217                      },
218                      "bold": {
219                        "name": "700",
220                        "file": "https://fonts.gstatic.com/s/aronesans/v4/TUZezwhrmbFp0Srr_tH6fv6RcUejHO_u7GF5aXfv-U2QzBLF6gslWpj6DW03no5mBF4.ttf"
221                      }
222                    },
223                    "family": "AR One Sans"
224                  },
225                  "font_body": {
226                    "variants": {
227                      "light": {
228                        "name": "300",
229                        "file": "https://fonts.gstatic.com/s/abeezee/v22/esDR31xSG-6AGleN6tKukbcHCpE.ttf"
230                      },
231                      "regular": {
232                        "name": "regular",
233                        "file": "https://fonts.gstatic.com/s/abeezee/v22/esDR31xSG-6AGleN6tKukbcHCpE.ttf"
234                      },
235                      "medium": {
236                        "name": "500",
237                        "file": "https://fonts.gstatic.com/s/abeezee/v22/esDR31xSG-6AGleN6tKukbcHCpE.ttf"
238                      },
239                      "semi_bold": {
240                        "name": "600",
241                        "file": "https://fonts.gstatic.com/s/abeezee/v22/esDR31xSG-6AGleN6tKukbcHCpE.ttf"
242                      },
243                      "bold": {
244                        "name": "700",
245                        "file": "https://fonts.gstatic.com/s/abeezee/v22/esDR31xSG-6AGleN6tKukbcHCpE.ttf"
246                      }
247                    },
248                    "family": "ABeeZee"
249                  },
250                  "large_logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/3874/applications/65ebf1b676b65eec1cf4b362/theme/pictures/free/original/theme-image-1709966264554.png",
251                  "small_logo": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/company/3874/applications/65ebf1b676b65eec1cf4b362/theme/pictures/free/original/theme-image-1709966264554.png",
252                  "contact_description": "",
253                  "image_container_bg": "#F96A6A",
254                  "img_fill": true
255                }
256              }
257            },
258            "page": [
259              {
260                "page": "product-description",
261                "settings": {
262                  "props": {
263                    "extension": {
264                      "below_price_component": [],
265                      "below_delivery_location": [],
266                      "product_description_bottom": [
267                        {
268                          "extension_id": "621ce569cb91ec40e4d6c019",
269                          "extension_name": "Product Recommendation",
270                          "config": {
271                            "extension_config_id": "62330effd4e498a1acfdaaa6",
272                            "extension_id": "621ce569cb91ec40e4d6c019",
273                            "organization_id": "60b48f67ff08196f3d811cfa"
274                          },
275                          "template": {
276                            "slug": "",
277                            "display": "Brand",
278                            "restrict_page": [
279                              "product"
280                            ],
281                            "wrapper": "<div id=\"ext-product-recommendation_brand\"></div>",
282                            "_id": "62330effd4e498da1cfdaaa7"
283                          }
284                        }
285                      ]
286                    }
287                  }
288                }
289              }
290            ]
291          }
292        ]
293      },
294      "_id": "6601290cb114315f0244c634",
295      "name": "Updated copy of Gala",
296      "application_id": "65ebf1b676b65eec1cf4b362",
297      "company_id": 3874,
298      "marketplace_theme_id": "65fd59d4131a1418b6f9326b",
299      "template_theme_id": "65fd688925b1ff067153a46f",
300      "applied": true,
301      "is_private": false,
302      "version": "1.1.8",
303      "styles": {},
304      "tags": [
305        "ASTRA"
306      ],
307      "meta": {
308        "payment": {
309          "is_paid": false,
310          "amount": 0
311        },
312        "description": "An exquisite fusion of elegance and functionality, designed to captivate the fashion-conscious. This visually enchanting and user-friendly option seamlessly harmonizes style and ease of use. Boasting optimised speed and search engine optimisation (SEO), it ensures a remarkable website that enthrals visitors while securing high rankings on search engines.",
313        "industry": [
314          "Restaurants",
315          "Pet supplies",
316          "Jewelry and accessories"
317        ],
318        "release": {
319          "notes": "<div class=\"p-rich_text_section\"><strong data-stringify-type=\"bold\">Release Note: Version 1.1.8</strong></div>\n<div class=\"p-rich_text_section\"><br /><strong data-stringify-type=\"bold\">Bug Fix:</strong></div>\n<ul class=\"p-rich_text_list p-rich_text_list__bullet\" data-stringify-type=\"unordered-list\" data-indent=\"0\" data-border=\"0\">\n<li data-stringify-indent=\"0\" data-stringify-border=\"0\">Fixed a bug where the price was not changing according to weight. Prices will now adjust correctly based on the specified weight.</li>\n</ul>",
320          "version": "1.1.8"
321        },
322        "images": {
323          "desktop": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/Xcn6zy_kf-images_desktop.png",
324          "mobile": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyndnp/wrkr/addsale/misc/pictures/free-icon/original/Szrq246Pv-images_mobile.png"
325        },
326        "slug": "gala",
327        "name": "Gala"
328      },
329      "theme_type": "vue2",
330      "global_sections": [
331        {
332          "section": {
333            "name": "section_extension",
334            "label": "Sale WWE",
335            "props": {
336              "extension": {
337                "type": "extension",
338                "value": {
339                  "section_extension": [
340                    {
341                      "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
342                      "extension_name": "Announcement Bar",
343                      "config": {
344                        "extension_config_id": "64343e3d9dfbcb0782db99ba",
345                        "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
346                        "organization_id": "60b48f67ff08196f3d811cfa"
347                      },
348                      "template": {
349                        "slug": "",
350                        "display": "Announcement Bar Header",
351                        "restrict_page": [],
352                        "wrapper": "<div id=\"ext-announcement-bar-header-bottom-view\"></div>",
353                        "_id": "64343e3d9dfbcb0782db99bb"
354                      }
355                    }
356                  ]
357                }
358              }
359            },
360            "blocks": [],
361            "__source": {
362              "id": "",
363              "bundle_name": "",
364              "type": "themeBundle"
365            },
366            "global_reference": "65eed62e288e8e21835f9e5d",
367            "preset": {},
368            "predicate": {
369              "screen": {
370                "mobile": true,
371                "desktop": true,
372                "tablet": true
373              },
374              "user": {
375                "authenticated": true,
376                "anonymous": true
377              },
378              "route": {
379                "selected": "none",
380                "exact_url": ""
381              },
382              "platform": {
383                "ios": true,
384                "android": true,
385                "web": true
386              },
387              "schedule": {
388                "cron": "",
389                "start": "",
390                "end": ""
391              },
392              "zones": []
393            }
394          },
395          "default_section": {
396            "name": "section_extension",
397            "label": "Extensions",
398            "props": [
399              {
400                "type": "extension",
401                "id": "extension",
402                "label": "Extension Positions",
403                "info": "Handle extension in these positions",
404                "positions": [
405                  {
406                    "value": "section_extension",
407                    "text": ""
408                  }
409                ]
410              }
411            ],
412            "blocks": []
413          },
414          "_id": "65eed62e288e8e21835f9e5d"
415        },
416        {
417          "section": {
418            "name": "section_extension",
419            "label": "Announcement",
420            "props": {
421              "extension": {
422                "type": "extension",
423                "value": {
424                  "section_extension": [
425                    {
426                      "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
427                      "extension_name": "Announcement Bar",
428                      "config": {
429                        "extension_config_id": "64343e3d9dfbcb0782db99ba",
430                        "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
431                        "organization_id": "60b48f67ff08196f3d811cfa"
432                      },
433                      "template": {
434                        "slug": "",
435                        "display": "Announcement Bar Header",
436                        "restrict_page": [],
437                        "wrapper": "<div id=\"ext-announcement-bar-header-bottom-view\"></div>",
438                        "_id": "64343e3d9dfbcb0782db99bb"
439                      }
440                    }
441                  ]
442                }
443              }
444            },
445            "blocks": [],
446            "__source": {
447              "id": "",
448              "bundle_name": "",
449              "type": "themeBundle"
450            },
451            "global_reference": "66012829b114315f0244c5ef",
452            "preset": {},
453            "predicate": {
454              "screen": {
455                "mobile": true,
456                "desktop": true,
457                "tablet": true
458              },
459              "user": {
460                "authenticated": true,
461                "anonymous": true
462              },
463              "route": {
464                "selected": "none",
465                "exact_url": ""
466              },
467              "platform": {
468                "ios": true,
469                "android": true,
470                "web": true
471              },
472              "schedule": {
473                "cron": "",
474                "start": "",
475                "end": ""
476              },
477              "zones": []
478            }
479          },
480          "default_section": {
481            "name": "section_extension",
482            "label": "Extensions",
483            "props": [
484              {
485                "type": "extension",
486                "id": "extension",
487                "label": "Extension Positions",
488                "info": "Handle extension in these positions",
489                "positions": [
490                  {
491                    "value": "section_extension",
492                    "text": ""
493                  }
494                ]
495              }
496            ],
497            "blocks": []
498          },
499          "_id": "66012829b114315f0244c5ef"
500        },
501        {
502          "section": {
503            "name": "about_us",
504            "label": "About us",
505            "props": {
506              "heading": {
507                "type": "text",
508                "value": "About Wrapme"
509              },
510              "image": {
511                "value": "",
512                "type": "image_picker"
513              },
514              "description": {
515                "value": "",
516                "type": "textarea"
517              }
518            },
519            "blocks": [],
520            "__source": {
521              "id": "",
522              "bundle_name": "",
523              "type": "themeBundle"
524            },
525            "preset": {},
526            "predicate": {
527              "screen": {
528                "mobile": true,
529                "desktop": true,
530                "tablet": true
531              },
532              "user": {
533                "authenticated": true,
534                "anonymous": true
535              },
536              "route": {
537                "selected": "none",
538                "exact_url": ""
539              },
540              "platform": {
541                "ios": true,
542                "android": true,
543                "web": true
544              },
545              "schedule": {
546                "cron": "",
547                "start": "",
548                "end": ""
549              },
550              "zones": []
551            }
552          },
553          "default_section": {
554            "name": "about_us",
555            "label": "About Us",
556            "props": [
557              {
558                "type": "text",
559                "id": "heading",
560                "label": "Heading",
561                "default": "",
562                "info": "Text for the heading"
563              },
564              {
565                "id": "image",
566                "type": "image_picker",
567                "label": "Image",
568                "default": "",
569                "options": {
570                  "aspect_ratio": "1:1",
571                  "aspect_ratio_strict_check": true
572                }
573              },
574              {
575                "type": "textarea",
576                "id": "description",
577                "label": "Description",
578                "default": "",
579                "info": "Text for the description"
580              }
581            ],
582            "blocks": []
583          },
584          "_id": "66013ee4cb669c0e8475326e"
585        },
586        {
587          "section": {
588            "name": "section_extension",
589            "label": "Wrapme weekends",
590            "props": {
591              "extension": {
592                "type": "extension",
593                "value": {
594                  "section_extension": [
595                    {
596                      "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
597                      "extension_name": "Announcement Bar",
598                      "config": {
599                        "extension_config_id": "64343e3d9dfbcb0782db99ba",
600                        "extension_id": "6232cfdcf0ba7c05ae6fe1c4",
601                        "organization_id": "60b48f67ff08196f3d811cfa"
602                      },
603                      "template": {
604                        "slug": "",
605                        "display": "Announcement Bar Header",
606                        "restrict_page": [],
607                        "wrapper": "<div id=\"ext-announcement-bar-header-bottom-view\"></div>",
608                        "_id": "64343e3d9dfbcb0782db99bb"
609                      }
610                    }
611                  ]
612                }
613              }
614            },
615            "blocks": [],
616            "__source": {
617              "id": "",
618              "bundle_name": "",
619              "type": "themeBundle"
620            },
621            "global_reference": "660158f5b114315f0244cac0",
622            "preset": {},
623            "predicate": {
624              "screen": {
625                "mobile": true,
626                "desktop": true,
627                "tablet": true
628              },
629              "user": {
630                "authenticated": true,
631                "anonymous": true
632              },
633              "route": {
634                "selected": "none",
635                "exact_url": ""
636              },
637              "platform": {
638                "ios": true,
639                "android": true,
640                "web": true
641              },
642              "schedule": {
643                "cron": "",
644                "start": "",
645                "end": ""
646              },
647              "zones": []
648            }
649          },
650          "default_section": {
651            "name": "section_extension",
652            "label": "Extensions",
653            "props": [
654              {
655                "type": "extension",
656                "id": "extension",
657                "label": "Extension Positions",
658                "info": "Handle extension in these positions",
659                "positions": [
660                  {
661                    "value": "section_extension",
662                    "text": ""
663                  }
664                ]
665              }
666            ],
667            "blocks": []
668          },
669          "_id": "660158f5b114315f0244cac0"
670        }
671      ],
672      "created_at": "2024-03-25T07:34:36.642Z",
673      "updated_at": "2024-03-28T09:25:18.530Z"
674    }
675  }
676}

User

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

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

application/user/create/v1

this event is triggered when user 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
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
is_created
boolean
Required
Shows if it is a new user or updated user
updated_at
string
Required
accountType
string
Indicates if user is created by system or by normal sign up flow
external_id
string
account_type
string
Required
Indicates if user is created by system or by normal sign up flow
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
Notifies if user expired password
socialAccounts
array of Undefined Type
Required
User's social login details and source of user account creation from another platform
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": "array",
76      "items": {
77        "type": "object",
78        "required": [
79          "user",
80          "socialAccounts"
81        ],
82        "properties": {
83          "user": {
84            "type": "object",
85            "required": [
86              "active",
87              "archive",
88              "status",
89              "_id",
90              "emails",
91              "username",
92              "account_type",
93              "phone_numbers",
94              "application_id",
95              "user_id",
96              "created_at",
97              "updated_at",
98              "is_created"
99            ],
100            "properties": {
101              "id": {
102                "type": "string"
103              },
104              "__v": {
105                "type": "integer"
106              },
107              "_id": {
108                "type": "string"
109              },
110              "dob": {
111                "type": [
112                  "string",
113                  "null"
114                ]
115              },
116              "meta": {
117                "type": [
118                  "string",
119                  "object"
120                ],
121                "description": "Meta information for users"
122              },
123              "active": {
124                "type": "boolean",
125                "description": "Shows whether user is blocked or unblocked"
126              },
127              "emails": {
128                "type": "array",
129                "items": [
130                  {
131                    "type": "object",
132                    "required": [
133                      "active",
134                      "primary",
135                      "verified",
136                      "email"
137                    ],
138                    "properties": {
139                      "email": {
140                        "type": "string"
141                      },
142                      "active": {
143                        "type": "boolean"
144                      },
145                      "primary": {
146                        "type": "boolean"
147                      },
148                      "verified": {
149                        "type": "boolean"
150                      }
151                    }
152                  }
153                ],
154                "description": "User emails' array"
155              },
156              "gender": {
157                "type": [
158                  "string",
159                  "null"
160                ],
161                "description": "User gender"
162              },
163              "status": {
164                "type": "string",
165                "description": "Status of the user, e.g. activated"
166              },
167              "userId": {
168                "type": "string",
169                "description": "User's unique ID"
170              },
171              "archive": {
172                "type": "boolean",
173                "description": "Shows whether user is deleted or present"
174              },
175              "user_id": {
176                "type": "string",
177                "description": "User's unique ID"
178              },
179              "lastName": {
180                "type": "string",
181                "description": "Last name of the user"
182              },
183              "username": {
184                "type": "string",
185                "description": "User name of the user"
186              },
187              "createdAt": {
188                "type": "string"
189              },
190              "firstName": {
191                "type": "string",
192                "description": "First name of the user"
193              },
194              "last_name": {
195                "type": "string",
196                "description": "Last name of the user"
197              },
198              "updatedAt": {
199                "type": "string"
200              },
201              "created_at": {
202                "type": "string"
203              },
204              "externalId": {
205                "type": "string"
206              },
207              "first_name": {
208                "type": "string",
209                "description": "First name of the user"
210              },
211              "is_created": {
212                "type": "boolean",
213                "description": "Shows if it is a new user or updated user"
214              },
215              "updated_at": {
216                "type": "string"
217              },
218              "accountType": {
219                "type": "string",
220                "description": "Indicates if user is created by system or by normal sign up flow"
221              },
222              "external_id": {
223                "type": "string"
224              },
225              "account_type": {
226                "type": "string",
227                "description": "Indicates if user is created by system or by normal sign up flow"
228              },
229              "phoneNumbers": {
230                "type": "array",
231                "items": [
232                  {
233                    "type": "object",
234                    "required": [
235                      "active",
236                      "primary",
237                      "verified",
238                      "phone",
239                      "countryCode",
240                      "country_code"
241                    ],
242                    "properties": {
243                      "phone": {
244                        "type": "string"
245                      },
246                      "active": {
247                        "type": "boolean"
248                      },
249                      "primary": {
250                        "type": "boolean"
251                      },
252                      "verified": {
253                        "type": "boolean"
254                      },
255                      "countryCode": {
256                        "type": "integer"
257                      },
258                      "country_code": {
259                        "type": "integer"
260                      }
261                    }
262                  }
263                ],
264                "description": "User phone numbers' array"
265              },
266              "applicationId": {
267                "type": "string",
268                "description": "Unique ID of the application"
269              },
270              "phone_numbers": {
271                "type": "array",
272                "items": [
273                  {
274                    "type": "object",
275                    "required": [
276                      "active",
277                      "primary",
278                      "verified",
279                      "phone",
280                      "countryCode",
281                      "country_code"
282                    ],
283                    "properties": {
284                      "phone": {
285                        "type": "string",
286                        "description": "Phone number of user"
287                      },
288                      "active": {
289                        "type": "boolean",
290                        "description": "Marked true if number is active"
291                      },
292                      "primary": {
293                        "type": "boolean",
294                        "description": "Marked true if number is primary. Primary numbers cannot be removed from account"
295                      },
296                      "verified": {
297                        "type": "boolean",
298                        "description": "Marked true if number is verified by user"
299                      },
300                      "countryCode": {
301                        "type": "integer"
302                      },
303                      "country_code": {
304                        "type": "integer",
305                        "description": "Country code of user phone number"
306                      }
307                    }
308                  }
309                ],
310                "description": "User phone numbers' array"
311              },
312              "profilePicUrl": {
313                "type": "string",
314                "description": "Link to the profile picture of the user"
315              },
316              "application_id": {
317                "type": "string",
318                "description": "Unique ID of the application"
319              },
320              "profile_pic_url": {
321                "type": "string",
322                "description": "Link to the profile picture of the user"
323              },
324              "hasOldPasswordHash": {
325                "type": "boolean"
326              },
327              "has_old_password_hash": {
328                "type": "boolean",
329                "description": "Notifies if user expired password"
330              }
331            }
332          },
333          "socialAccounts": {
334            "type": "array",
335            "items": {},
336            "description": "User's social login details and source of user account creation from another platform"
337          }
338        }
339      }
340    }
341  }
342}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "deadlock.5904b351-f1bc-11ee-8c89-23e32fd9851b"
5    ],
6    "name": "user",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712150174469,
10    "id": "RMeNKW2ieZrNFPMJ99uEUYhNLekjtKoKKGyrGBTnObo=",
11    "category": "application"
12  },
13  "company_id": 2326,
14  "application_id": [
15    "62d798d9578cc9c73cc2f834",
16    "*"
17  ],
18  "contains": [
19    "0"
20  ],
21  "payload": [
22    {
23      "user": {
24        "_id": "660d569e3f1730ce55d06690",
25        "username": "918888888888_12345",
26        "firstName": "test",
27        "lastName": "test",
28        "phoneNumbers": [
29          {
30            "phone": "8888888888",
31            "countryCode": 91,
32            "active": true,
33            "primary": true,
34            "verified": true,
35            "country_code": 91
36          }
37        ],
38        "emails": [
39          {
40            "email": "test@example.com",
41            "active": true,
42            "primary": true,
43            "verified": true
44          }
45        ],
46        "gender": "male",
47        "accountType": "user",
48        "active": true,
49        "archive": false,
50        "status": "activated",
51        "profilePicUrl": "https://hdn-1.fynd.com/default-profile_nxhzui.png",
52        "hasOldPasswordHash": false,
53        "meta": "{\"email_id\":\"test@example.com\",\"user_guid\":\"e8315b98-9e8e-4fd9-899e-4e95536af985\",\"token\":\"\",\"epoch_timestamp\":\"\",\"is_custom_image\":\"0\",\"user\":{\"name\":\"test test\",\"mobile_no\":\"1111111111\",\"social_user_image\":\"\",\"dob\":\"1998-10-02\",\"gender\":\"\",\"city_id\":\"\",\"state_id\":\"\",\"pincode\":\"\"}}",
54        "userId": "660d569e3f1730ce55d06690",
55        "applicationId": "62d798d9578cc9c73cc2f834",
56        "createdAt": "2024-04-03T13:16:14.440Z",
57        "updatedAt": "2024-04-03T13:16:14.440Z",
58        "__v": 0,
59        "first_name": "test",
60        "last_name": "test",
61        "phone_numbers": [
62          {
63            "phone": "8888888888",
64            "countryCode": 91,
65            "active": true,
66            "primary": true,
67            "verified": true,
68            "country_code": 91
69          }
70        ],
71        "account_type": "user",
72        "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",
73        "has_old_password_hash": false,
74        "user_id": "660d569e3f1730ce55d06690",
75        "application_id": "62d798d9578cc9c73cc2f834",
76        "created_at": "2024-04-03T13:16:14.440Z",
77        "updated_at": "2024-04-03T13:16:14.440Z",
78        "is_created": true
79      },
80      "socialAccounts": []
81    }
82  ]
83}

application/user/delete/v1

this event is triggered when user 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
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
updated_at
string
Required
accountType
string
external_id
string
account_type
string
Required
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
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": "array",
76      "items": {
77        "type": "object",
78        "required": [
79          "user"
80        ],
81        "properties": {
82          "user": {
83            "type": "object",
84            "required": [
85              "active",
86              "archive",
87              "status",
88              "_id",
89              "emails",
90              "username",
91              "account_type",
92              "phone_numbers",
93              "application_id",
94              "user_id",
95              "created_at",
96              "updated_at"
97            ],
98            "properties": {
99              "id": {
100                "type": "string"
101              },
102              "__v": {
103                "type": "integer"
104              },
105              "_id": {
106                "type": "string"
107              },
108              "dob": {
109                "type": [
110                  "string",
111                  "null"
112                ]
113              },
114              "meta": {
115                "type": [
116                  "string",
117                  "object"
118                ],
119                "description": "Meta information for users"
120              },
121              "active": {
122                "type": "boolean",
123                "description": "Shows whether user is blocked or unblocked"
124              },
125              "emails": {
126                "type": "array",
127                "items": [
128                  {
129                    "type": "object",
130                    "required": [
131                      "active",
132                      "primary",
133                      "verified",
134                      "email"
135                    ],
136                    "properties": {
137                      "email": {
138                        "type": "string"
139                      },
140                      "active": {
141                        "type": "boolean"
142                      },
143                      "primary": {
144                        "type": "boolean"
145                      },
146                      "verified": {
147                        "type": "boolean"
148                      }
149                    }
150                  }
151                ],
152                "description": "User emails' array"
153              },
154              "gender": {
155                "type": [
156                  "string",
157                  "null"
158                ],
159                "description": "User gender"
160              },
161              "status": {
162                "type": "string",
163                "description": "Status of the user, e.g. activated"
164              },
165              "userId": {
166                "type": "string",
167                "description": "User's unique ID"
168              },
169              "archive": {
170                "type": "boolean",
171                "description": "Shows whether user is deleted or present"
172              },
173              "user_id": {
174                "type": "string",
175                "description": "User's unique ID"
176              },
177              "lastName": {
178                "type": "string",
179                "description": "Last name of the user"
180              },
181              "username": {
182                "type": "string",
183                "description": "User name of the user"
184              },
185              "createdAt": {
186                "type": "string"
187              },
188              "firstName": {
189                "type": "string",
190                "description": "First name of the user"
191              },
192              "last_name": {
193                "type": "string",
194                "description": "Last name of the user"
195              },
196              "updatedAt": {
197                "type": "string"
198              },
199              "created_at": {
200                "type": "string"
201              },
202              "externalId": {
203                "type": "string"
204              },
205              "first_name": {
206                "type": "string",
207                "description": "First name of the user"
208              },
209              "updated_at": {
210                "type": "string"
211              },
212              "accountType": {
213                "type": "string"
214              },
215              "external_id": {
216                "type": "string"
217              },
218              "account_type": {
219                "type": "string"
220              },
221              "phoneNumbers": {
222                "type": "array",
223                "items": [
224                  {
225                    "type": "object",
226                    "required": [
227                      "active",
228                      "primary",
229                      "verified",
230                      "phone",
231                      "country_code"
232                    ],
233                    "properties": {
234                      "phone": {
235                        "type": "string"
236                      },
237                      "active": {
238                        "type": "boolean"
239                      },
240                      "primary": {
241                        "type": "boolean"
242                      },
243                      "verified": {
244                        "type": "boolean"
245                      },
246                      "country_code": {
247                        "type": "integer"
248                      }
249                    }
250                  }
251                ],
252                "description": "User phone numbers' array"
253              },
254              "applicationId": {
255                "type": "string",
256                "description": "Unique ID of the application"
257              },
258              "phone_numbers": {
259                "type": "array",
260                "items": [
261                  {
262                    "type": "object",
263                    "required": [
264                      "active",
265                      "primary",
266                      "verified",
267                      "phone",
268                      "country_code"
269                    ],
270                    "properties": {
271                      "phone": {
272                        "type": "string"
273                      },
274                      "active": {
275                        "type": "boolean"
276                      },
277                      "primary": {
278                        "type": "boolean"
279                      },
280                      "verified": {
281                        "type": "boolean"
282                      },
283                      "country_code": {
284                        "type": "integer"
285                      }
286                    }
287                  }
288                ],
289                "description": "User phone numbers' array"
290              },
291              "profilePicUrl": {
292                "type": "string",
293                "description": "Link to the profile picture of the user"
294              },
295              "application_id": {
296                "type": "string",
297                "description": "Unique ID of the application"
298              },
299              "profile_pic_url": {
300                "type": "string",
301                "description": "Link to the profile picture of the user"
302              },
303              "hasOldPasswordHash": {
304                "type": "boolean"
305              },
306              "has_old_password_hash": {
307                "type": "boolean"
308              }
309            }
310          }
311        }
312      }
313    }
314  }
315}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "deadlock.3650e0f1-f14d-11ee-aaf4-6512b1239800"
5    ],
6    "name": "user",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712102442111,
10    "id": "xAcjtwW4TJxDgBIXs7JpsYI8iV4JzNsn2pQzHniSVwU=",
11    "category": "application"
12  },
13  "company_id": 1,
14  "application_id": [
15    "000000000000000000000003",
16    "*"
17  ],
18  "contains": [
19    "0"
20  ],
21  "payload": [
22    {
23      "user": {
24        "_id": "65ded54761afa80deb0e49d9",
25        "username": "918888888888_12345",
26        "emails": [],
27        "gender": "male",
28        "active": true,
29        "archive": true,
30        "status": "deleted",
31        "__v": 0,
32        "first_name": "test",
33        "last_name": "test",
34        "phone_numbers": [
35          {
36            "phone": "8888888888",
37            "active": true,
38            "primary": true,
39            "verified": true,
40            "country_code": 91
41          }
42        ],
43        "account_type": "user",
44        "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",
45        "has_old_password_hash": false,
46        "user_id": "65ded54761afa80deb0e49d9",
47        "application_id": "000000000000000000000003",
48        "created_at": "2024-02-28T06:40:07.084Z",
49        "updated_at": "2024-03-04T08:07:10.021Z",
50        "is_created": false
51      }
52    }
53  ]
54}

application/user/update/v1

this event is triggered when user 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
array of object
Required
Array of Properties
user
object
Required
Properties
id
string
__v
integer
_id
string
Required
dob
string|null
meta
string|object
Meta information for users
active
boolean
Required
Shows whether user is blocked or unblocked
emails
array of Undefined Type
Required
User emails' array
gender
string|null
User gender
status
string
Required
Status of the user, e.g. activated
userId
string
User's unique ID
archive
boolean
Required
Shows whether user is deleted or present
user_id
string
Required
User's unique ID
lastName
string
Last name of the user
username
string
Required
User name of the user
createdAt
string
firstName
string
First name of the user
last_name
string
Last name of the user
updatedAt
string
created_at
string
Required
externalId
string
first_name
string
First name of the user
is_created
boolean
Required
Shows if it is a new user or updated user
updated_at
string
Required
accountType
string
external_id
string
account_type
string
Required
phoneNumbers
array of Undefined Type
User phone numbers' array
applicationId
string
Unique ID of the application
phone_numbers
array of Undefined Type
Required
User phone numbers' array
profilePicUrl
string
Link to the profile picture of the user
application_id
string
Required
Unique ID of the application
profile_pic_url
string
Link to the profile picture of the user
hasOldPasswordHash
boolean
has_old_password_hash
boolean
socialAccounts
array of Undefined Type
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": "array",
76      "items": {
77        "type": "object",
78        "required": [
79          "user",
80          "socialAccounts"
81        ],
82        "properties": {
83          "user": {
84            "type": "object",
85            "required": [
86              "active",
87              "archive",
88              "status",
89              "_id",
90              "emails",
91              "username",
92              "account_type",
93              "phone_numbers",
94              "application_id",
95              "user_id",
96              "created_at",
97              "updated_at",
98              "is_created"
99            ],
100            "properties": {
101              "id": {
102                "type": "string"
103              },
104              "__v": {
105                "type": "integer"
106              },
107              "_id": {
108                "type": "string"
109              },
110              "dob": {
111                "type": [
112                  "string",
113                  "null"
114                ]
115              },
116              "meta": {
117                "type": [
118                  "string",
119                  "object"
120                ],
121                "description": "Meta information for users"
122              },
123              "active": {
124                "type": "boolean",
125                "description": "Shows whether user is blocked or unblocked"
126              },
127              "emails": {
128                "type": "array",
129                "items": [
130                  {
131                    "type": "object",
132                    "required": [
133                      "active",
134                      "primary",
135                      "verified",
136                      "email"
137                    ],
138                    "properties": {
139                      "email": {
140                        "type": "string"
141                      },
142                      "active": {
143                        "type": "boolean"
144                      },
145                      "primary": {
146                        "type": "boolean"
147                      },
148                      "verified": {
149                        "type": "boolean"
150                      }
151                    }
152                  }
153                ],
154                "description": "User emails' array"
155              },
156              "gender": {
157                "type": [
158                  "string",
159                  "null"
160                ],
161                "description": "User gender"
162              },
163              "status": {
164                "type": "string",
165                "description": "Status of the user, e.g. activated"
166              },
167              "userId": {
168                "type": "string",
169                "description": "User's unique ID"
170              },
171              "archive": {
172                "type": "boolean",
173                "description": "Shows whether user is deleted or present"
174              },
175              "user_id": {
176                "type": "string",
177                "description": "User's unique ID"
178              },
179              "lastName": {
180                "type": "string",
181                "description": "Last name of the user"
182              },
183              "username": {
184                "type": "string",
185                "description": "User name of the user"
186              },
187              "createdAt": {
188                "type": "string"
189              },
190              "firstName": {
191                "type": "string",
192                "description": "First name of the user"
193              },
194              "last_name": {
195                "type": "string",
196                "description": "Last name of the user"
197              },
198              "updatedAt": {
199                "type": "string"
200              },
201              "created_at": {
202                "type": "string"
203              },
204              "externalId": {
205                "type": "string"
206              },
207              "first_name": {
208                "type": "string",
209                "description": "First name of the user"
210              },
211              "is_created": {
212                "type": "boolean",
213                "description": "Shows if it is a new user or updated user"
214              },
215              "updated_at": {
216                "type": "string"
217              },
218              "accountType": {
219                "type": "string"
220              },
221              "external_id": {
222                "type": "string"
223              },
224              "account_type": {
225                "type": "string"
226              },
227              "phoneNumbers": {
228                "type": "array",
229                "items": [
230                  {
231                    "type": "object",
232                    "required": [
233                      "active",
234                      "primary",
235                      "verified",
236                      "phone",
237                      "countryCode",
238                      "country_code"
239                    ],
240                    "properties": {
241                      "phone": {
242                        "type": "string"
243                      },
244                      "active": {
245                        "type": "boolean"
246                      },
247                      "primary": {
248                        "type": "boolean"
249                      },
250                      "verified": {
251                        "type": "boolean"
252                      },
253                      "countryCode": {
254                        "type": "integer"
255                      },
256                      "country_code": {
257                        "type": "integer"
258                      }
259                    }
260                  }
261                ],
262                "description": "User phone numbers' array"
263              },
264              "applicationId": {
265                "type": "string",
266                "description": "Unique ID of the application"
267              },
268              "phone_numbers": {
269                "type": "array",
270                "items": [
271                  {
272                    "type": "object",
273                    "required": [
274                      "active",
275                      "primary",
276                      "verified",
277                      "phone",
278                      "countryCode",
279                      "country_code"
280                    ],
281                    "properties": {
282                      "phone": {
283                        "type": "string"
284                      },
285                      "active": {
286                        "type": "boolean"
287                      },
288                      "primary": {
289                        "type": "boolean"
290                      },
291                      "verified": {
292                        "type": "boolean"
293                      },
294                      "countryCode": {
295                        "type": "integer"
296                      },
297                      "country_code": {
298                        "type": "integer"
299                      }
300                    }
301                  }
302                ],
303                "description": "User phone numbers' array"
304              },
305              "profilePicUrl": {
306                "type": "string",
307                "description": "Link to the profile picture of the user"
308              },
309              "application_id": {
310                "type": "string",
311                "description": "Unique ID of the application"
312              },
313              "profile_pic_url": {
314                "type": "string",
315                "description": "Link to the profile picture of the user"
316              },
317              "hasOldPasswordHash": {
318                "type": "boolean"
319              },
320              "has_old_password_hash": {
321                "type": "boolean"
322              }
323            }
324          },
325          "socialAccounts": {
326            "type": "array",
327            "items": {}
328          }
329        }
330      }
331    }
332  }
333}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "deadlock.71a89261-f198-11ee-9442-013da6cd3006"
5    ],
6    "name": "user",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712134753926,
10    "id": "V4GnyhAWzn0zPksqPxCeIQgwRfruO2mWQfu7Gka0c3A=",
11    "category": "application"
12  },
13  "company_id": 5842,
14  "application_id": [
15    "6523fa5f41f4eb4c10a1d869",
16    "*"
17  ],
18  "contains": [
19    "0"
20  ],
21  "payload": [
22    {
23      "user": {
24        "_id": "6604625d5e26b4665dd0ee65",
25        "username": "test_example_com_12345",
26        "firstName": "test",
27        "lastName": "test",
28        "phoneNumbers": [
29          {
30            "phone": "8888888888",
31            "countryCode": 91,
32            "active": true,
33            "primary": true,
34            "verified": true,
35            "country_code": 91
36          }
37        ],
38        "emails": [
39          {
40            "email": "test@example.com",
41            "active": true,
42            "primary": true,
43            "verified": true
44          }
45        ],
46        "gender": "female",
47        "accountType": "user",
48        "active": true,
49        "archive": false,
50        "status": "activated",
51        "profilePicUrl": "https://hdn-1.fynd.com/default-profile_nxhzui.png",
52        "hasOldPasswordHash": false,
53        "userId": "6604625d5e26b4665dd0ee65",
54        "applicationId": "6523fa5f41f4eb4c10a1d869",
55        "createdAt": "2024-03-27T18:15:57.458Z",
56        "updatedAt": "2024-04-03T08:59:13.909Z",
57        "__v": 0,
58        "meta": "{\"_id\":\"6604625d5e26b4665dd0ee65\",\"username\":\"test\",\"emails\":[{\"email\":\"test@example.com\",\"active\":true,\"primary\":true,\"verified\":true}],\"gender\":\"female\",\"active\":true,\"first_name\":\"test\",\"last_name\":\"test\",\"phone_numbers\":[{\"phone\":\"1111111111\",\"active\":true,\"primary\":true,\"verified\":true,\"country_code\":91}],\"account_type\":\"user\",\"profile_pic_url\":\"https://hdn-1.fynd.com/company/884/applications/000000000000000000000001/theme/pictures/free/original/default-profile_nxhzui.png\",\"user_id\":\"6604625d5e26b4665dd0ee65\",\"application_id\":\"6523fa5f41f4eb4c10a1d869\",\"created_at\":\"2024-03-27T18:15:57.458Z\",\"updated_at\":\"2024-03-27T18:15:57.458Z\",\"meta\":\"{}\",\"REVIEWS\":{\"9805785\":{\"ORDERS\":{\"FY660CF77F0EE4DB5EF0\":{\"17121258248161234467\":{\"quantity\":1}}},\"VERIFIED_REVIEW_COUNT\":0,\"REVIEW_COUNT\":0},\"9929758\":{\"ORDERS\":{\"FY660462C20EAD78A2F7\":{\"17115634590311655479\":{\"quantity\":1}}},\"VERIFIED_REVIEW_COUNT\":0,\"REVIEW_COUNT\":0}}}",
59        "first_name": "test",
60        "last_name": "test",
61        "phone_numbers": [
62          {
63            "phone": "8888888888",
64            "countryCode": 91,
65            "active": true,
66            "primary": true,
67            "verified": true,
68            "country_code": 91
69          }
70        ],
71        "account_type": "user",
72        "profile_pic_url": "https://hdn-1.fynd.com/default-profile_nxhzui.png",
73        "has_old_password_hash": false,
74        "user_id": "6604625d5e26b4665dd0ee65",
75        "application_id": "6523fa5f41f4eb4c10a1d869",
76        "created_at": "2024-03-27T18:15:57.458Z",
77        "updated_at": "2024-04-03T08:59:13.909Z",
78        "is_created": false
79      },
80      "socialAccounts": []
81    }
82  ]
83}

Variant configuration

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

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

application/variant/create/v1

this event is triggered when variant configuration is created.

Payload
Properties
application_id
array of
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
variant
object
Required
Variant configuration details.
Properties
id
string
Required
UUID of the variant configuration.
app_id
string
Required
Unique ID of the application.
key
string
Required
Unique Key for the attribute variant.
name
string
Required
Display name of the variant.
is_active
boolean
Required
Active status of the variant.
is_default
boolean
Whether this is the default variant configuration.
size
object
Required
Specifies the minimum and maximum number of variants to display.
Properties
min
integer
Minimum number of variants to be displayed.
max
integer
Maximum number of variants to be displayed.
logo
string
URL for the logo image of the variant.
priority
integer
Display priority for the variant.
display_type
string
Required
Type of display for the variant, e.g., text or image.
Enum
show
boolean
Visibility of the variant on the UI.
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      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered."
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object.",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event"
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "is_active",
81            "app_id",
82            "key",
83            "name",
84            "size",
85            "display_type",
86            "id"
87          ],
88          "properties": {
89            "id": {
90              "type": "string",
91              "description": "UUID of the variant configuration."
92            },
93            "app_id": {
94              "type": "string",
95              "description": "Unique ID of the application."
96            },
97            "key": {
98              "type": "string",
99              "description": "Unique Key for the attribute variant."
100            },
101            "name": {
102              "type": "string",
103              "description": "Display name of the variant."
104            },
105            "is_active": {
106              "type": "boolean",
107              "description": "Active status of the variant."
108            },
109            "is_default": {
110              "type": "boolean",
111              "description": "Whether this is the default variant configuration."
112            },
113            "size": {
114              "type": "object",
115              "description": "Specifies the minimum and maximum number of variants to display.",
116              "properties": {
117                "min": {
118                  "type": "integer",
119                  "description": "Minimum number of variants to be displayed."
120                },
121                "max": {
122                  "type": "integer",
123                  "description": "Maximum number of variants to be displayed."
124                }
125              }
126            },
127            "logo": {
128              "type": "string",
129              "description": "URL for the logo image of the variant."
130            },
131            "priority": {
132              "type": "integer",
133              "description": "Display priority for the variant."
134            },
135            "display_type": {
136              "type": "string",
137              "enum": [
138                "color",
139                "text",
140                "swatch_image",
141                "product_image"
142              ],
143              "description": "Type of display for the variant, e.g., text or image."
144            },
145            "show": {
146              "type": "boolean",
147              "description": "Visibility of the variant on the UI."
148            }
149          },
150          "description": "Variant configuration details."
151        }
152      }
153    }
154  }
155}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/storearchive/misc/default-assets/original/popular.png",
34      "priority": 1,
35      "display_type": "text",
36      "show": true
37    }
38  }
39}

application/variant/update/v1

this event is triggered when variant configuration is updated.

Payload
Properties
application_id
array of
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
variant
object
Required
Variant configuration details.
Properties
id
string
Required
UUID of the variant configuration.
app_id
string
Required
Unique ID of the application.
key
string
Required
Unique Key for the attribute variant.
name
string
Required
Display name of the variant.
is_active
boolean
Required
Active status of the variant.
is_default
boolean
Whether this is the default variant configuration.
size
object
Required
Specifies the minimum and maximum number of variants to display.
Properties
min
integer
Minimum number of variants to be displayed.
max
integer
Maximum number of variants to be displayed.
logo
string
URL for the logo image of the variant.
priority
integer
Display priority for the variant.
display_type
string
Required
Type of display for the variant, e.g., text or image.
Enum
show
boolean
Visibility of the variant on the UI.
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      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered"
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event."
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "is_active",
81            "app_id",
82            "key",
83            "name",
84            "size",
85            "display_type",
86            "id"
87          ],
88          "properties": {
89            "id": {
90              "type": "string",
91              "description": "UUID of the variant configuration."
92            },
93            "app_id": {
94              "type": "string",
95              "description": "Unique ID of the application."
96            },
97            "key": {
98              "type": "string",
99              "description": "Unique Key for the attribute variant."
100            },
101            "name": {
102              "type": "string",
103              "description": "Display name of the variant."
104            },
105            "is_active": {
106              "type": "boolean",
107              "description": "Active status of the variant."
108            },
109            "is_default": {
110              "type": "boolean",
111              "description": "Whether this is the default variant configuration."
112            },
113            "size": {
114              "type": "object",
115              "description": "Specifies the minimum and maximum number of variants to display.",
116              "properties": {
117                "min": {
118                  "type": "integer",
119                  "description": "Minimum number of variants to be displayed."
120                },
121                "max": {
122                  "type": "integer",
123                  "description": "Maximum number of variants to be displayed."
124                }
125              }
126            },
127            "logo": {
128              "type": "string",
129              "description": "URL for the logo image of the variant."
130            },
131            "priority": {
132              "type": "integer",
133              "description": "Display priority for the variant."
134            },
135            "display_type": {
136              "type": "string",
137              "enum": [
138                "color",
139                "text",
140                "swatch_image",
141                "product_image"
142              ],
143              "description": "Type of display for the variant, e.g., text or image."
144            },
145            "show": {
146              "type": "boolean",
147              "description": "Visibility of the variant on the UI."
148            }
149          },
150          "description": "Variant configuration details."
151        }
152      }
153    }
154  }
155}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "logo": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/storearchive/misc/default-assets/original/popular.png",
34      "priority": 1,
35      "display_type": "text",
36      "show": true
37    }
38  }
39}

application/variant/delete/v1

this event is triggered when variant configuration is deleted.

Payload
Properties
application_id
array of
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
variant
object
Required
Variant configuration details.
Properties
id
string
Required
UUID of the variant configuration.
key
string
Required
Unique Key for the attribute variant.
name
string
Required
Display name of the variant.
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      "description": "Sales channel ID for which this event is triggered."
14    },
15    "company_id": {
16      "type": "integer",
17      "description": "Company ID for which this event is triggered"
18    },
19    "contains": {
20      "type": "array",
21      "description": "This array will have all the keys present at root level of 'payload' object.",
22      "items": {
23        "type": "string"
24      }
25    },
26    "event": {
27      "type": "object",
28      "required": [
29        "category",
30        "created_timestamp",
31        "id",
32        "name",
33        "trace_id",
34        "type",
35        "version"
36      ],
37      "properties": {
38        "category": {
39          "type": "string",
40          "description": "Category of the event. If it is at sales channel level or company level."
41        },
42        "created_timestamp": {
43          "type": "integer",
44          "description": "Event generation timestamp in epoch milliseconds."
45        },
46        "id": {
47          "type": "string",
48          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver."
49        },
50        "name": {
51          "type": "string",
52          "description": "Name of the event."
53        },
54        "trace_id": {
55          "type": "array",
56          "description": "Internal trace_id for Fynd Platform services.",
57          "items": {
58            "type": "string"
59          }
60        },
61        "type": {
62          "type": "string",
63          "description": "Type/Action of the event. e.g. create/update/delete."
64        },
65        "version": {
66          "type": "string",
67          "description": "Version of the event."
68        }
69      }
70    },
71    "payload": {
72      "type": "object",
73      "required": [
74        "variant"
75      ],
76      "properties": {
77        "variant": {
78          "type": "object",
79          "required": [
80            "key",
81            "name",
82            "id"
83          ],
84          "properties": {
85            "id": {
86              "type": "string",
87              "description": "UUID of the variant configuration."
88            },
89            "key": {
90              "type": "string",
91              "description": "Unique Key for the attribute variant."
92            },
93            "name": {
94              "type": "string",
95              "description": "Display name of the variant."
96            }
97          },
98          "description": "Variant configuration details."
99        }
100      }
101    }
102  }
103}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "silverbolt.3f80dad4-f2bc-11ee-b736-92d34068c369"
5    ],
6    "name": "variant",
7    "type": "delete",
8    "version": "1",
9    "created_timestamp": 1712260082824,
10    "id": "xjazBsVwGyBmiSmTf3M4rdAE542AfUji3z8F1i2eRT4=",
11    "category": "application",
12    "referer": "fyndx1.de"
13  },
14  "company_id": 26130,
15  "application_id": [
16    "660edfcaaaaa57fb0b439b31"
17  ],
18  "contains": [
19    "variant"
20  ],
21  "payload": {
22    "variant": {
23      "id": "6773ca37c1f7b57fcc7892ec",
24      "is_active": true,
25      "app_id": "676ac38c6073bad0cc4a4a5e",
26      "key": "test-attribute",
27      "name": "testing",
28      "is_default": false,
29      "size": {
30        "min": 1,
31        "max": 1
32      },
33      "priority": 1,
34      "display_type": "text",
35      "show": true
36    }
37  }
38}

Zone

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

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

application/zone/create/v1

this event is triggered when zone is created

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
zone
object
Required
Properties
zone_id
string
Required
Zone ID
slug
string
Required
Slug of the region associated with the zone
name
string
Required
Canonical name of slug
geo_areas
array of string
Required
Geoarea ids of the zone
regions
array of object
Required
List of Region Data for the created/updated zone
Array of Properties
country
string
Country for specific list of regions
regions
array of string
company_id
integer
Required
Company id of the created/updated zone
product
object
Required
Product type and tags associated with the zone
Properties
values
array of string
Required
List of values of given type associated with the zone
type
string
Required
Type of product category to be selected for zone
Enum
stores
object
Required
Channels associated with the zone
Properties
type
string
Type of store category selected
Enum
values
array of integer
List of Store ids selected
required
Undefined Type
is_active
boolean
Required
Indicates whether the zone is active or not
application_id
string
Required
Application id for the zone
stage
string
Stage of the zone
Enum
overlapping_file_url
string
Nullable
If error in bulk upload then error file url
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "properties": {
69        "zone": {
70          "type": "object",
71          "properties": {
72            "zone_id": {
73              "type": "string",
74              "description": "Zone ID"
75            },
76            "slug": {
77              "type": "string",
78              "description": "Slug of the region associated with the zone"
79            },
80            "name": {
81              "type": "string",
82              "description": "Canonical name of slug"
83            },
84            "geo_areas": {
85              "type": "array",
86              "items": {
87                "type": "string"
88              },
89              "description": "Geoarea ids of the zone"
90            },
91            "regions": {
92              "type": "array",
93              "items": {
94                "type": "object",
95                "properties": {
96                  "country": {
97                    "type": "string",
98                    "description": "Country for specific list of regions"
99                  },
100                  "regions": {
101                    "type": "array",
102                    "items": {
103                      "type": "string",
104                      "description": "List of region ids for the country"
105                    }
106                  }
107                }
108              },
109              "description": "List of Region Data for the created/updated zone"
110            },
111            "company_id": {
112              "type": "integer",
113              "description": "Company id of the created/updated zone"
114            },
115            "product": {
116              "type": "object",
117              "properties": {
118                "values": {
119                  "type": "array",
120                  "items": {
121                    "type": "string"
122                  },
123                  "description": "List of values of given type associated with the zone"
124                },
125                "type": {
126                  "type": "string",
127                  "description": "Type of product category to be selected for zone",
128                  "enum": [
129                    "department",
130                    "category",
131                    "item_id",
132                    "all",
133                    "tag"
134                  ]
135                }
136              },
137              "required": [
138                "values",
139                "type"
140              ],
141              "description": "Product type and tags associated with the zone"
142            },
143            "stores": {
144              "type": "object",
145              "properties": {
146                "type": {
147                  "type": "string",
148                  "description": "Type of store category selected",
149                  "enum": [
150                    "custom",
151                    "all"
152                  ]
153                },
154                "values": {
155                  "type": "array",
156                  "items": {
157                    "type": "integer"
158                  },
159                  "description": "List of Store ids selected"
160                },
161                "required": [
162                  "type",
163                  "values"
164                ]
165              },
166              "description": "Channels associated with the zone"
167            },
168            "is_active": {
169              "type": "boolean",
170              "description": "Indicates whether the zone is active or not"
171            },
172            "application_id": {
173              "type": "string",
174              "description": "Application id for the zone"
175            },
176            "stage": {
177              "type": "string",
178              "description": "Stage of the zone",
179              "enum": [
180                "failed",
181                "partial",
182                "completed",
183                "in_progress"
184              ]
185            },
186            "overlapping_file_url": {
187              "type": "string",
188              "nullable": true,
189              "description": "If error in bulk upload then error file url"
190            }
191          },
192          "required": [
193            "zone_id",
194            "slug",
195            "name",
196            "company_id",
197            "stores",
198            "product",
199            "is_active",
200            "geo_areas",
201            "regions",
202            "application_id"
203          ]
204        }
205      },
206      "required": [
207        "zone"
208      ]
209    }
210  }
211}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.0e0ecb4e-f4ae-49c0-ac08-6cab9ca03b05"
5    ],
6    "name": "zone",
7    "type": "create",
8    "version": "1",
9    "created_timestamp": 1711951311,
10    "id": "2WvgiyhP8hNQSLLifA/UHN17yq7nQTRha4B/0tzEzzg=",
11    "category": "company"
12  },
13  "company_id": 18376,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "zone_id": "660a4dcf51c9e512f3c78515",
20      "slug": "zone-z2foq",
21      "name": "Zone1",
22      "company_id": 18376,
23      "geo_areas": [
24        "geo_area"
25      ],
26      "stores": {
27        "type": "custom",
28        "values": [
29          49666
30        ]
31      },
32      "product": {
33        "type": "all",
34        "values": []
35      },
36      "regions": [
37        {
38          "country": "country",
39          "regions": [
40            "region"
41          ]
42        }
43      ],
44      "is_active": true,
45      "stage": "completed",
46      "application_id": "660a4dcf51c9e512f3c78515"
47    }
48  }
49}

application/zone/update/v1

this event is triggered when zone is updated

Payload
Properties
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
zone
object
Properties
zone_id
string
Required
Zone ID
slug
string
Required
Slug of the region associated with the zone
name
string
Required
Canonical name of slug
geo_areas
array of string
Required
Geoarea ids of the zone
regions
array of object
Required
List of Region Data for the created/updated zone
Array of Properties
country
string
Country for specific list of regions
regions
array of string
company_id
integer
Required
Company id of the created/updated zone
product
object
Required
Product type and tags associated with the zone
Properties
values
array of string
Required
List of values of given type associated with the zone
type
string
Required
Type of product category to be selected for zone
Enum
stores
object
Required
Channels associated with the zone
Properties
type
string
Type of store category selected
Enum
values
array of integer
List of Store ids selected
required
Undefined Type
is_active
boolean
Required
Indicates whether the zone is active or not
application_id
string
Required
Application id for the zone
stage
string
Stage of the zone
Enum
overlapping_file_url
string
Nullable
If error in bulk upload then error file url
Payload Schema JSON
1{
2  "type": "object",
3  "required": [
4    "company_id",
5    "contains",
6    "event",
7    "payload"
8  ],
9  "properties": {
10    "company_id": {
11      "type": "integer",
12      "description": "company ID for which this event is triggered"
13    },
14    "contains": {
15      "type": "array",
16      "description": "This array will have all the keys present at root level of 'payload' object",
17      "items": {
18        "type": "string"
19      }
20    },
21    "event": {
22      "type": "object",
23      "required": [
24        "category",
25        "created_timestamp",
26        "id",
27        "name",
28        "trace_id",
29        "type",
30        "version"
31      ],
32      "properties": {
33        "category": {
34          "type": "string",
35          "description": "category of the event. If it is at sales channel level or company level"
36        },
37        "created_timestamp": {
38          "type": "integer",
39          "description": "event generation timestamp in epoch milliseconds"
40        },
41        "id": {
42          "type": "string",
43          "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
44        },
45        "name": {
46          "type": "string",
47          "description": "Name of the event"
48        },
49        "trace_id": {
50          "type": "array",
51          "description": "internal trace_id for Fynd Platform services",
52          "items": {
53            "type": "string"
54          }
55        },
56        "type": {
57          "type": "string",
58          "description": "Type/Action of the event. e.g. create/update/delete"
59        },
60        "version": {
61          "type": "string",
62          "description": "Version of the event."
63        }
64      }
65    },
66    "payload": {
67      "type": "object",
68      "properties": {
69        "zone": {
70          "type": "object",
71          "properties": {
72            "zone_id": {
73              "type": "string",
74              "description": "Zone ID"
75            },
76            "slug": {
77              "type": "string",
78              "description": "Slug of the region associated with the zone"
79            },
80            "name": {
81              "type": "string",
82              "description": "Canonical name of slug"
83            },
84            "geo_areas": {
85              "type": "array",
86              "items": {
87                "type": "string"
88              },
89              "description": "Geoarea ids of the zone"
90            },
91            "regions": {
92              "type": "array",
93              "items": {
94                "type": "object",
95                "properties": {
96                  "country": {
97                    "type": "string",
98                    "description": "Country for specific list of regions"
99                  },
100                  "regions": {
101                    "type": "array",
102                    "items": {
103                      "type": "string",
104                      "description": "List of region ids for the country"
105                    }
106                  }
107                }
108              },
109              "description": "List of Region Data for the created/updated zone"
110            },
111            "company_id": {
112              "type": "integer",
113              "description": "Company id of the created/updated zone"
114            },
115            "product": {
116              "type": "object",
117              "properties": {
118                "values": {
119                  "type": "array",
120                  "items": {
121                    "type": "string"
122                  },
123                  "description": "List of values of given type associated with the zone"
124                },
125                "type": {
126                  "type": "string",
127                  "description": "Type of product category to be selected for zone",
128                  "enum": [
129                    "department",
130                    "category",
131                    "item_id",
132                    "all",
133                    "tag"
134                  ]
135                }
136              },
137              "required": [
138                "values",
139                "type"
140              ],
141              "description": "Product type and tags associated with the zone"
142            },
143            "stores": {
144              "type": "object",
145              "properties": {
146                "type": {
147                  "type": "string",
148                  "description": "Type of store category selected",
149                  "enum": [
150                    "custom",
151                    "all"
152                  ]
153                },
154                "values": {
155                  "type": "array",
156                  "items": {
157                    "type": "integer"
158                  },
159                  "description": "List of Store ids selected"
160                },
161                "required": [
162                  "type",
163                  "values"
164                ]
165              },
166              "description": "Channels associated with the zone"
167            },
168            "is_active": {
169              "type": "boolean",
170              "description": "Indicates whether the zone is active or not"
171            },
172            "application_id": {
173              "type": "string",
174              "description": "Application id for the zone"
175            },
176            "stage": {
177              "type": "string",
178              "description": "Stage of the zone",
179              "enum": [
180                "failed",
181                "partial",
182                "completed",
183                "in_progress"
184              ]
185            },
186            "overlapping_file_url": {
187              "type": "string",
188              "nullable": true,
189              "description": "If error in bulk upload then error file url"
190            }
191          },
192          "required": [
193            "zone_id",
194            "slug",
195            "name",
196            "company_id",
197            "stores",
198            "product",
199            "is_active",
200            "geo_areas",
201            "regions",
202            "application_id"
203          ]
204        }
205      }
206    }
207  }
208}
Payload Example
1{
2  "event": {
3    "trace_id": [
4      "stormbreaker.e6b4d431-e77c-4f21-aa6c-1972949dd567"
5    ],
6    "name": "zone",
7    "type": "update",
8    "version": "1",
9    "created_timestamp": 1711901438,
10    "id": "ekAHB7u0rNUjGRInx15tFznDERKa15ciwSG/paS0NX8=",
11    "category": "company"
12  },
13  "company_id": 18361,
14  "contains": [
15    "zone"
16  ],
17  "payload": {
18    "zone": {
19      "zone_id": "660a4dcf51c9e512f3c78515",
20      "slug": "zone-z2foq",
21      "name": "Zone1",
22      "company_id": 18376,
23      "geo_areas": [
24        "geo_area"
25      ],
26      "stores": {
27        "type": "custom",
28        "values": [
29          49666
30        ]
31      },
32      "product": {
33        "type": "all",
34        "values": []
35      },
36      "regions": [
37        {
38          "country": "country",
39          "regions": [
40            "region"
41          ]
42        }
43      ],
44      "is_active": true,
45      "stage": "completed",
46      "application_id": "660a4dcf51c9e512f3c78515"
47    }
48  }
49}

Previous
« Article
Next
Category »