Company
Events categorised under company level will be triggered when any action performed on company. e.g. If new brand is created.
Events
company/article/create/v1
# this event is triggered when article is created
company/article/delete/v1
# this event is triggered when article is deleted
company/article/update/v1
# this event is triggered when article is updated
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
articles
array of object
Required
Array of Properties
id
string
Unique identifier for the article.
uid
string
Required
Combination of item code and store ID to uniquely identify the article.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at
string
| date-time
Date and time when the pricing information was last updated.
store
object
Required
Information about the store selling the product.
Properties
id
integer
Required
Unique identifier for the store.
is_set
boolean
Indicates if the product is sold as part of a set.
weight
object
Required
Weight details of the product.
Properties
unit
string
Required
Unit of weight measurement (e.g., kg, lbs).
shipping
number
Required
Shipping weight of the product.
is_default
boolean
Indicates if this is the default weight configuration.
company
object
Required
Information about the company producing or selling the product.
Properties
id
integer
Required
Unique identifier for the company.
item_id
integer
Required
Unique identifier for the item.
date_meta
object
Timestamps for important events in the product's lifecycle.
Properties
created_on
string
| date-time
Date and time when the product was first created.
modified_on
string
| date-time
Required
Last modification timestamp of the product inventory details.
added_on_store
string
| date-time
Date and time when the product was added to the store.
inventory_updated_on
string
| date-time
Last inventory update timestamp.
dimension
object
Required
Dimension details of the product.
Properties
unit
string
Required
Unit of dimension measurement (e.g., cm, inches).
width
number
Required
Width of the product.
height
number
Required
Height of the product.
length
number
Required
Length of the product.
is_default
boolean
Indicates if these are the default dimensions.
is_active
boolean
Indicates if the product is currently active (available for sale).
identifier
object
Required
Product-specific identifier details.
quantities
object
Information about product quantities, including available and unavailable stock.
Properties
damaged
object
Details of damaged stock.
Properties
count
integer
Required
Number of damaged units.
updated_at
string
Required
Timestamp of the last damaged stock update.
sellable
object
Required
Sellable stock information.
Properties
count
integer
Required
Number of sellable units available.
updated_at
string
Required
Timestamp of the last sellable stock update.
not_available
object
Information about unavailable stock.
Properties
count
integer
Required
Number of unavailable units.
updated_at
string
Required
Timestamp of the last unavailable stock update.
order_committed
object
Details of committed orders.
Properties
count
integer
Number of units committed to orders.
updated_at
string
Timestamp of the last order committed update.
_custom_json
object
Custom JSON data associated with the product.
trader
array of object
List of traders associated with the product.
Array of Properties
name
string
Trader's name.
type
string
Indicates the trader type.
Enum
address
array of string
List of addresses associated with the trader.
manufacturer
object
Required
Information about the product's manufacturer.
Properties
name
string
Required
Manufacturer's name.
address
string
Required
Manufacturer's physical address.
is_default
boolean
Indicates if this is the default manufacturer for the product.
return_config
object
Return policy configuration for the product.
Properties
unit
string
Time unit for the return period (either days or hours).
Enum
time
integer
Duration within which the product can be returned.
returnable
boolean
Required
Indicates if the product is returnable.
fynd_item_code
string
Required
Fynd's unique internal code for the product.
tax_identifier
object
Tax-related identification for the product.
Properties
hsn_code_id
string
HSN (Harmonized System of Nomenclature) code identifier.
total_quantity
integer
Required
Total quantity available for the product.
expiration_date
string
Expiration or validity end date for the product.
track_inventory
boolean
Indicates if inventory tracking is enabled for the product.
country_of_origin
string
Required
Country where the product was manufactured or originated.
stage
string
Current stage of the product lifecycle (e.g., verified).
set
object
Configuration of the set, if the product is sold as one.
Properties
quantity
integer
Total number of items in the set.
size_distribution
object
Size distribution details within the set.
Properties
sizes
array of object
List of sizes and their respective quantities.
Array of Properties
size
string
Label of the size (e.g., S, M, L).
pieces
integer
Quantity of pieces for the corresponding size.
seller_identifier
string
Required
Unique identifier used by the seller for the product.
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/brand/create/v1
# this event is triggered when brand is created
company/brand/update/v1
# this event is triggered when brand is updated
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
brand
object
Required
Brand details.
Properties
id
string
The unique ID of the brand.
uid
integer
Required
The UID of the brand.
_cls
string
Class information of the brand.
logo
string
Required
The URL of the brand's logo.
mode
string
The mode of the brand.
name
string
Required
The name of the brand.
stage
string
Required
The stage of the brand.
banner
object
The banner images of the brand.
Properties
portrait
string
The URL of the brand's portrait banner.
landscape
string
The URL of the brand's landscape banner.
slug_key
string
Required
The slug key of the brand.
synonyms
array of string
A list of synonyms for the brand name.
warnings
object
A dictionary of warnings related to the brand.
meta_json
object
The meta data for the brand.
Properties
company_id
integer
The ID of the company associated with this meta data.
company_id
integer
Required
The ID of the company the brand belongs to.
created_by
object
The user who created the brand.
Properties
user_id
string
Required
The unique ID of the user who created the brand.
username
string
Required
The username of the user who created the brand.
created_on
string
The date and time when the brand was created.
description
string
A description of the brand.
modified_by
object
The user who last modified the brand.
Properties
user_id
string
Required
The unique ID of the user who last modified the brand.
username
string
Required
The username of the user who last modified the brand.
modified_on
string
The date and time when the brand was last modified.
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
The unique ID of the user who verified the brand.
username
string
Required
The username of the user who verified the brand.
verified_on
string
The date and time when the brand was verified.
_custom_json
object
Custom JSON data for the brand.
_locale_language
object
The language settings for the brand.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
brand
object
Required
Brand details.
Properties
uid
integer
Required
The UID of the brand.
name
string
Required
The name of the brand.
stage
string
Required
The stage of the brand.
logo
string
Required
The URL of the brand's logo.
banner
object
Required
The banner images of the brand.
Properties
portrait
string
Required
The URL of the brand's portrait banner.
landscape
string
Required
The URL of the brand's landscape banner.
description
string
A description of the brand.
_locale_language
object
The language settings for the brand.
company_id
integer
Required
The ID of the company the brand belongs to.
id
string
Required
The unique ID of the brand.
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/company/create/v1
# this event is triggered when company is created
company/company/update/v1
# this event is triggered when company is updated
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
company
object
Required
Properties
_id
string
The unique identifier of the company
uid
integer
The user ID associated with the company
mode
string
The mode of the company
Enum
name
string
Required
The name of the company
stage
string
The stage of the company
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The rate value.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
Required
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
integer
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
country_code
string
The country code of the address.
documents
array of object
Required
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
created_by
object
The user who created the company
Properties
user_id
string
Required
User ID of the user who created the company
username
string
Required
Username of the user who created the company
created_on
string
The date and time when the company was created
modified_by
object
The user who last modified the company.
Properties
user_id
string
Required
User ID of the user who last modified the company
username
string
Required
Username of the user who last modified the company
modified_on
string
The date and time when the company was last modified
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
username
string
Required
Username of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
The phone number for contact person.
country_code
integer
Required
The country code for the contact person.
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
company
object
Required
Properties
_id
string
The unique identifier of the company
uid
integer
Required
The user ID associated with the company
mode
Undefined Type
The mode of the company
Enum
name
string
The name of the company
stage
string
Required
The stage of the company
taxes
array of object
The list of taxes associated with the company.
Array of Properties
rate
number
The rate value.
enable
boolean
A boolean value indicating whether the rate is enabled or not.
effective_date
string
The effective date of the rate.
domain
string
The domain associated with the company
warnings
object
The warnings associated with the company ( can contain any key value pair )
addresses
array of object
The list of addresses associated with the company.
Array of Properties
city
string
Required
The city of the address.
state
string
Required
The state of the address.
country
string
Required
The country of the address.
pincode
integer
Required
The pincode of the address.
address1
string
Required
The first line of the address.
address2
string
The second line of the address.
landmark
string
The landmark near the address.
latitude
number
Required
The latitude of the address.
longitude
number
Required
The longitude of the address.
address_type
string
The type of address.
country_code
string
The country code of the address.
documents
array of object
The list of documents associated with the company
Array of Properties
url
string
The URL of the document.
type
string
Required
The type of the document.
value
string
Required
The value of the document.
verified
boolean
Indicates whether the document is verified.
legal_name
string
The legal name associated with the document.
created_by
object
The user who created the company
Properties
user_id
string
Required
User ID of the user who created the company
username
string
Required
Username of the user who created the company
created_on
string
The date and time when the company was created
modified_by
object
Required
The user who last modified the company.
Properties
user_id
string
Required
User ID of the user who last modified the company
username
string
Required
Username of the user who last modified the company
modified_on
string
Required
The date and time when the company was last modified
verified_by
object
The user who verified the brand.
Properties
user_id
string
Required
User ID of the user who verified the company
username
string
Required
Username of the user who verified the company
verified_on
string
The date and time when the company was verified
_custom_json
object
Custom JSON data associated with the company
company_type
string
The type of the company
marketplaces
array of string
The list of marketplaces associated with the company
business_info
string
The business information of the company
business_type
string
The business type of the company
referral_info
object
The referral information associated with the company
Properties
referral_code
string
Referral code for the user
reject_reason
string
The reason why the company was rejected
contact_details
object
The contact details associated with the company
Properties
phone
array of object
List of phone numbers.
Array of Properties
number
string
Required
country_code
integer
Required
emails
array of string
List of email addresses.
business_details
object
Additional business details
Properties
website
object
Required
Details about the website of the business.
Properties
url
string
The URL of the website.
franchise_enabled
boolean
Whether the company is a franchise
notification_emails
array of string
The list of email addresses for notifications
business_country_info
object
The country and country code of the company
Properties
country
string
The name of the country where the business operates
country_code
string
The ISO 3166-1 alpha-2 country code of the country where the business operates
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/courier-partner/account-status/v1
# this event is triggered when courier-partner is account-statused
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
courier-partner
object
Required
Object containing the details for the courier partner including accouunt_id, extension id and such.
Properties
stage
string
Required
A string indicating current stage of account
scheme_id
string
Required
unique id of scheme
account_id
string
Required
unique id of account
extension_id
string
Required
extension api key
is_own_account
boolean
Required
Indicates whether the account belongs to the seller
Payload Schema JSON
Payload Example
Was this section helpful?
This event will be generated where there is any action done on customfield_definition
Events
company/customfield_definition/create/v1
# This event is triggered when a customfield definition is created
company/customfield_definition/delete/v1
# This event is triggered when a customfield definition is deleted
company/customfield_definition/update/v1
# This event is triggered when a customfield definition is updated
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
updated_by
string
The last user that edited this definition
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
Required
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
slug
string
Required
A unique identifier for the custom fields definition. Its required and will not be modified once created.
namespace
string
Required
Namespace is the initial part of the slug, like slug is designer.name then here designer is namespace and name is key. Its also not editable.
name
string
Required
Name of the custom fields. Its editable.
description
string
This is description about the custom field definition.
id
string
Required
Uniquely generated mongoId of custom field definition and its not editable.
type
string
Required
This is field_type of the custom field definition. Its non-editable
is_deleted
boolean
This indicates that this custom fields definition is deleted or not.
validations
array of Undefined Type
Validations array have supported validations for the custom field definition
multi_value
boolean
Required
This indicate that this custom fields can accept multiple values or not.multi_value false means it can have only 1 value.
resource
string
Required
Resource indicate that this custom field is assosiated with this resource.This is non-editable
company_id
string
Required
This is company id where this custom fields created.
required
boolean
This indicates whether the field is required or not
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/customfields/inventory-delete/v1
# This event is triggered when a custom field from inventory is deleted
company/customfields/inventory-update/v1
# This event is triggered when a custom field from inventory is updated
company/customfields/product-delete/v1
# This event is triggered when a custom field from product is deleted
company/customfields/product-update/v1
# This event is triggered when a custom field from product is updated
company/customfields/product-size-delete/v1
# This event is triggered when a custom field from product size is deleted
company/customfields/product-size-update/v1
# This event is triggered when a custom field from product size is updated
company/customfields/selling-location-update/v1
# This event is triggered when a custom field from selling location is updated
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for 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
company/customobject_definition/create/v1
# This event is triggered when customobject definition is created
company/customobject_definition/delete/v1
# This event is triggered when customobject definition is deleted"
company/customobject_definition/update/v1
# This event is triggered when customobject definition is updated
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object definition and its not editable.
name
string
Required
Name is use for the custom object definition name
slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
field_definitions
array of Undefined Type
Required
This indicates all the custom field definitions part of the custom object
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/customobjects/create/v1
# This event is triggered when a custom object is created
company/customobjects/update/v1
# This event is triggered when a custom object is updated
company/customobjects/delete/v1
# This event is triggered when a custom object is deleted
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
status
string
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object under a custom object definition
definition_slug
string
Required
A unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of Undefined Type
Required
This is list of custom fields values.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
status
string
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object
definition_slug
string
Required
Unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of Undefined Type
Required
This is list of custom fields values.
Payload Schema JSON
Payload Example
Was this section helpful?
Payload
company_id
integer
Required
Company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
Category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
Event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
Internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
id
string
Required
Uniquely generated mongoId of custom object and its not editable.
company_id
string
Required
This is company id where this custom object created.
status
string
This is use for active/inactive status of custom object entry
slug
string
Required
This is a unique identifier for a custom object
definition_slug
string
Required
Unique identifier for the custom object definition. Its required and will not be modified once created.
fields
array of object
Required
This is list of custom fields values.
Payload Schema JSON
Payload Example
Was this section helpful?
Events
company/location-price/create/v1
# this event is triggered when location price is created
company/location-price/update/v1
# this event is triggered when location price is updated
company/location-price/delete/v1
# this event is triggered when location price is deleted
Payload
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd 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.
size
string
Required
Product size (e.g., S, M, L, XL).
brand
object
Required
Details about the product's brand.
Properties
id
integer
Required
Unique identifier for the brand.
price
object
Required
Pricing details of the product, including various price types.
Properties
marked
number
Required
Marked price or original listed price of the product.
currency
string
Required
Currency used for the product's pricing (e.g., USD, EUR).
transfer
number
Required
Transfer price of the product.
effective
number
Required
Final price after applying discounts.
updated_at