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.
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
Payload
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
Payload Example
Was this section helpful?
Payload
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
Payload Example
Was this section helpful?
Payload
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
Payload Example
Was this section helpful?
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
Payload
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
Nullable
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.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
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
Nullable
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.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
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
Nullable
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.
Payload Schema JSON
Payload Example
Was this section helpful?
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
Payload
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 (available_pages_props_v1)
Required
Page-level configuration details
Array of available_pages_props_v1
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
Payload Example
Was this section helpful?
Payload
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 (available_pages_props_v1)
Required
Page-level configuration details
Array of available_pages_props_v1
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
Payload Example
Was this section helpful?
Payload
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 (available_pages_props_v1)
Required
Theme-level configuration details
Array of available_pages_props_v1
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
Payload Example
Was this section helpful?
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
Payload
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 (article-ids-schema)
Required
Defines the list of articles you want to apply the injection to.
Array of article-ids-schema
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.
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 under certain conditions.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
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
Payload Example
Was this section helpful?
Payload
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 (article-ids-schema)
Required
Defines the list of articles you want to apply the injection to.
Array of article-ids-schema
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
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
Payload Example
Was this section helpful?
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
Payload
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
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
Payload Example
Was this section helpful?
Payload
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
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
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
Payload Example
Was this section helpful?
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
Payload
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 a