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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
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
Payload Example
Was this section helpful?
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
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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 courier-partner is ndred
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
A string indicating the Ordering channel
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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.
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
string
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
Payload Example
Was this section helpful?
Events
application/legal/update/v1
# this event is triggered when legal 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
legal
object
Required
Properties
__v
integer
Required
Version Key Property - auto generated by system
_id
string
Required
Unique Identifier of a Legal Entry in DB - auto generated by system
faq
array of object
Required
List of Frequently Asked Questions
Array of Properties
question
string
The question of a FAQ query
answer
string
The answer of a FAQ query
tnc
string
Required
Content within 'Terms and Conditions'
policy
string
Required
Content within 'Privacy policy'
returns
string
Required
Content within 'Return policy'
shipping
string
Required
Content within 'Shipping policy'
createdAt
string
Required
updatedAt
string
Required
application
string
Required
sales channel ID to which the legal documents are associated
Payload Schema JSON
Payload Example
Was this section helpful?
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
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
| 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
Payload Example
Was this section helpful?
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
| 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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
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.
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
Payload Example
Was this section helpful?
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
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.
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
Payload Example
Was this section helpful?
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
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
Business Ordering channel. Possible values: fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
Payload Schema JSON
Payload Example
Was this section helpful?
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
Business Ordering channel. Possible values: fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
Payload Schema JSON
Payload Example
Was this section helpful?
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
Business Ordering channel. Possible values: fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
Payload Schema JSON
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Enum
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
Enum
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
Enum
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Enum
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
Enum
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
Enum
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
Payload Example
Was this section helpful?
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
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
ID of the user who approved the promotion
rejected_by
string
ID of the user who rejected the promotion
reviewed_by
string
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
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
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
Promotion approved ISOdate
rejected_on
string
Promotion rejected ISOdate
reviewed_on
string
Promotion reviewed on ISOdate
ownership
object
ownership details of the promotion
Properties
payable_by
string
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
Required
Promotional offer text to be shown on PDP or Cart
description
string
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
Payload Example
Was this section helpful?
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
ID of the user who approved the promotion
rejected_by
string
ID of the user who rejected the promotion
reviewed_by
string
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
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
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
Promotion approved ISOdate
rejected_on
string
Promotion rejected ISOdate
reviewed_on
string
Promotion reviewed on ISOdate
ownership
object
ownership details of the promotion
Properties
payable_by
string
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
Required
Promotional offer text to be shown on PDP or Cart
description
string
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
Payload Example
Was this section helpful?
Events
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
Events
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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/return-cancellation-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/return-cancellation-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.
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
Events
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
Payload Example
Was this section helpful?
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
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
Business Ordering channel. eg. are fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
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
Payload Example
Was this section helpful?
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
Business Ordering channel. eg. are fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
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
Payload Example
Was this section helpful?
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
Business Ordering channel. eg. are fynd, fynd_store, uniket, affiliate, ecomm, marketplace, jiomart
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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.
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?
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
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
Payload Example
Was this section helpful?
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
Payload Example
Was this section helpful?