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/product/create/v2
# this event is triggered when product is created
application/product/update/v2
# this event is triggered when product is updated
application/product/delete/v2
# this event is triggered when product is deleted
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product
array of object
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
scores
object
The product scores/metrics based on different parameters in a sales channel.
Properties
popularity
number
| value >= 0
| value <= 1
| float
This score captures how trending and popular a product is for a specific sales channel. It evaluates recent customer interactions such as views, wishlist adds, add-to-carts, and orders, applying time-based decay so newer activity matters more. The blended score is ranked within the channel to reflect relative popularity. A higher score means the product is currently engaging more customers, while a lower score shows limited or declining interest.
availability
number
| value >= 0
| value <= 1
| float
This score measures how reliably a product is stocked for a specific sales channel. It compares the product’s current inventory with its highest observed inventory level, adjusted for how inventory is distributed across locations. A higher score means the product is readily available, while a lower score indicates limited stock or frequent stockouts. Products with no meaningful inventory history receive a default low score for interpretation.
conversion
number
| value >= 0
| value <= 1
| float
This score measures how effectively a product converts customer interest into actual orders for a specific sales channel. It considers product views, wishlist adds, add-to-carts, and completed orders to calculate a conversion rate. The rate is then ranked within the channel to give a normalized score. A higher score means the product turns interest into purchases more successfully, while a lower score indicates weaker conversion performance.
sold_quantity
number
| value >= 0
| value <= 1
| float
This score evaluates how many units of a product have been sold for a specific sales channel, compared to other products in the same channel. It calculates total quantities sold and converts them into a percentile rank. A higher score means the product sells in large volumes, while a lower score signals fewer units sold. Products without transactions are assigned a default low score.
depth
number
| value >= 0
| value <= 1
| float
This score evaluates how well a product covers different size options for a specific sales channel within its category, while also factoring in the inventory available for each size. It compares the product’s size variety and stock depth against the maximum observed within that category and channel. A higher score means the product offers a broader and better-stocked size range, while a lower score reflects fewer options or limited inventory depth.
listing
number
| value >= 0
| value <= 1
| float
This score reflects how recently a product was listed for a specific sales channel. It uses the product’s listing date to calculate how many days have passed since it became available, then normalizes this against other products in the same channel. A higher score means the product is relatively new and fresh on the channel, while a lower score indicates it has been listed for a longer time or lacks valid listing information.
discount
number
| value >= 0
| value <= 1
| float
This score reflects the level of discount a product offers for a specific sales channel, relative to others in the channel. It compares the product’s listed price (MRP) to its effective selling price (ESP) and ranks products by discount percentage. It also takes into account Discount Rules. A higher score indicates steeper discounts, while a lower score shows smaller or no discounts. Products without valid price data receive a default low score.
cancelled
number
| value >= 0
| value <= 1
| float
This score measures the proportion of orders cancelled by the platform for a specific sales channel. A higher score indicates fewer cancellations, suggesting smoother fulfilment and better operational consistency. A lower score highlights products more prone to cancellations, which may result from inventory mismatches, processing issues, or operational inefficiencies.
returns
number
| value >= 0
| value <= 1
| float
This score measures the proportion of orders that were returned for a specific sales channel. It is designed so that a higher score indicates fewer returns relative to total orders, reflecting better product reliability and customer satisfaction. A lower score means the product experiences more returns, which could signal quality issues, mismatched expectations, or customer dissatisfaction.
catalogue
number
| value >= 0
| value <= 1
| float
This score evaluates the quality and completeness of a product’s catalogue content for a specific sales channel. It considers the presence of images, videos, and 3D models, along with the length of product descriptions. Balanced image counts, supportive media, and detailed descriptions contribute to a higher score. A higher score means the product is well-presented and informative, while a lower score indicates missing media or insufficient descriptions that may reduce customer confidence.
revenue
number
| value >= 0
| value <= 1
| float
This score measures how much revenue a product generates for a specific sales channel, relative to other products in that channel. It looks at the total value of items sold and assigns a percentile rank. A higher score indicates the product drives stronger sales revenue, while a lower score means it contributes less revenue compared to peers. Products with no sales activity receive a default low score.
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. In case of bundle items type will be ("virtual_bundle" or "physical_bundle")
Enum
medias
array of object
A list of media items associated with the product, such as images or videos.
Array of Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Required
The name of the product.
price
Undefined Type
The pricing details of the product.
Properties
effective
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
Required
A URL-friendly string representing the product.
teaser_tag
string
A teaser tag string providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
Required
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
Required
The unique identifier for the brand associated with the product.
category_uid
integer
Required
The unique identifier for the category to which the product belongs.
verification_status
string
Verification status of the product.
Enum
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
Required
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
Required
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Required
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Required
Indicates whether the product can be considered as a gift.
is_cod
boolean
Required
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Required
Indicates whether the product depends on another product.
is_available
boolean
Required
Indicates whether the product is currently available for purchase.
moq
object
Required
The order quantity details required to purchase the product.
Properties
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object
Required
The SEO details related to the product, including metadata for search engine optimization.
Properties
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object
Properties
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object
Array of Properties
url
string
action
object
Properties
page
object
type
string
Required
meta_tags
array of object
Array of Properties
title
string
Required
items
array of object
Array of Properties
key
string
Required
value
string
Required
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object
Array of Properties
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
Enum
value
number
The numerical value representing the net quantity of the product.
custom_order
object
Custom order details for the product.
Properties
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Required
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object
Custom meta associated with the product.
Array of Properties
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
no_of_boxes
integer
Number of boxes containing the product.
created_on
string
| date-time
The date and time when the product was created
modified_on
string
| date-time
The date and time when the product was last modified
sizes_with_identifiers
array of object
Sizes along with their identifiers.
Array of Properties
size
string
Size of the item.
identifiers
array of object
List of identifiers (e.g., SKU codes, GTINs).
Array of Properties
gtin_type
string
Required
Type of GTIN identifier (e.g., SKU, UPC, EAN).
gtin_value
string
Required
Value of the GTIN identifier.
bundle_details
array of object
An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.
Array of Properties
is_base
boolean
A flag that determines if child product is base product of bundle.
seller_identifier
string
Seller Identifier of the bundle child product.
net_quantity
number
Net quantity of the bundle child product.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "properties": {77 "product": {78 "type": "array",79 "items": {80 "type": "object",81 "properties": {82 "attributes": {83 "type": "object",84 "additionalProperties": true,85 "description": "Additional attributes of the product, such as custom properties or features."86 },87 "brand": {88 "properties": {89 "action": {90 "type": "object",91 "description": "Schema to define the Action Object",92 "properties": {93 "type": {94 "type": "string",95 "description": "Type of action to be taken e.g, page.",96 "example": "test"97 },98 "page": {99 "type": "object",100 "description": "Represents the page details used for rendering.",101 "required": [102 "type"103 ],104 "properties": {105 "params": {106 "type": "object",107 "description": "Parameters that should be considered in path.",108 "additionalProperties": {109 "type": "array",110 "items": {111 "type": "string",112 "description": "A string parameter for the action."113 }114 }115 },116 "query": {117 "type": "object",118 "description": "Query parameter if any to be added to the action.",119 "additionalProperties": {120 "type": "array",121 "items": {122 "type": "string",123 "description": "A string query parameter for the action."124 }125 }126 },127 "url": {128 "type": "string",129 "description": "The URL for the action."130 },131 "type": {132 "type": "string",133 "description": "The type of action such as product, products, category, brand.",134 "enum": [135 "about-us",136 "addresses",137 "blog",138 "brands",139 "cards",140 "cart",141 "categories",142 "brand",143 "category",144 "collection",145 "collections",146 "custom",147 "contact-us",148 "external",149 "faq",150 "freshchat",151 "home",152 "notification-settings",153 "orders",154 "page",155 "policy",156 "product",157 "product-request",158 "products",159 "profile",160 "profile-order-shipment",161 "profile-basic",162 "profile-company",163 "profile-emails",164 "profile-phones",165 "rate-us",166 "refer-earn",167 "settings",168 "shared-cart",169 "tnc",170 "track-order",171 "wishlist",172 "sections",173 "form",174 "cart-delivery",175 "cart-payment",176 "cart-review",177 "login",178 "register",179 "shipping-policy",180 "return-policy",181 "order-status",182 "locate-us"183 ]184 }185 }186 },187 "popup": {188 "type": "object",189 "description": "Represents the page details used for rendering.",190 "required": [191 "type"192 ],193 "properties": {194 "params": {195 "type": "object",196 "description": "Parameters that should be considered in path.",197 "additionalProperties": {198 "type": "array",199 "items": {200 "type": "string",201 "description": "A string parameter for the action."202 }203 }204 },205 "query": {206 "type": "object",207 "description": "Query parameter if any to be added to the action.",208 "additionalProperties": {209 "type": "array",210 "items": {211 "type": "string",212 "description": "A string query parameter for the action."213 }214 }215 },216 "url": {217 "type": "string",218 "description": "The URL for the action."219 },220 "type": {221 "type": "string",222 "description": "The type of action such as product, products, category, brand.",223 "enum": [224 "about-us",225 "addresses",226 "blog",227 "brands",228 "cards",229 "cart",230 "categories",231 "brand",232 "category",233 "collection",234 "collections",235 "custom",236 "contact-us",237 "external",238 "faq",239 "freshchat",240 "home",241 "notification-settings",242 "orders",243 "page",244 "policy",245 "product",246 "product-request",247 "products",248 "profile",249 "profile-order-shipment",250 "profile-basic",251 "profile-company",252 "profile-emails",253 "profile-phones",254 "rate-us",255 "refer-earn",256 "settings",257 "shared-cart",258 "tnc",259 "track-order",260 "wishlist",261 "sections",262 "form",263 "cart-delivery",264 "cart-payment",265 "cart-review",266 "login",267 "register",268 "shipping-policy",269 "return-policy",270 "order-status",271 "locate-us"272 ]273 }274 }275 }276 }277 },278 "logo": {279 "description": "Media information about the product, including metadata, type, URL, and alternative text.",280 "properties": {281 "meta": {282 "type": "object",283 "additionalProperties": true,284 "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."285 },286 "type": {287 "type": "string",288 "enum": [289 "image",290 "video",291 "3d_model"292 ],293 "description": "The type of media."294 },295 "url": {296 "type": "string",297 "description": "The URL where the media can be accessed."298 },299 "alt": {300 "type": "string",301 "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."302 },303 "thumbnail": {304 "type": "string",305 "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."306 }307 },308 "required": [309 "url"310 ],311 "type": "object"312 },313 "name": {314 "type": "string"315 },316 "uid": {317 "type": "integer"318 }319 },320 "type": "object",321 "description": "The brand associated with the product."322 },323 "description": {324 "type": "string",325 "description": "A detailed description of the product."326 },327 "discount": {328 "type": "string",329 "description": "The discount applied to the product."330 },331 "has_variant": {332 "type": "boolean",333 "description": "Indicates whether the product has variants, such as different sizes or colors."334 },335 "highlights": {336 "items": {337 "type": "string"338 },339 "type": "array",340 "description": "Key highlights of the product."341 },342 "image_nature": {343 "type": "string",344 "enum": [345 "default",346 "standard"347 ],348 "description": "The nature of the product image, indicating if it's the default or a standard image."349 },350 "scores": {351 "type": "object",352 "description": "The product scores/metrics based on different parameters in a sales channel.",353 "properties": {354 "popularity": {355 "type": "number",356 "format": "float",357 "minimum": 0,358 "maximum": 1,359 "description": "This score captures how trending and popular a product is for a specific sales channel. It evaluates recent customer interactions such as views, wishlist adds, add-to-carts, and orders, applying time-based decay so newer activity matters more. The blended score is ranked within the channel to reflect relative popularity. A higher score means the product is currently engaging more customers, while a lower score shows limited or declining interest."360 },361 "availability": {362 "type": "number",363 "format": "float",364 "minimum": 0,365 "maximum": 1,366 "description": "This score measures how reliably a product is stocked for a specific sales channel. It compares the product’s current inventory with its highest observed inventory level, adjusted for how inventory is distributed across locations. A higher score means the product is readily available, while a lower score indicates limited stock or frequent stockouts. Products with no meaningful inventory history receive a default low score for interpretation."367 },368 "conversion": {369 "type": "number",370 "format": "float",371 "minimum": 0,372 "maximum": 1,373 "description": "This score measures how effectively a product converts customer interest into actual orders for a specific sales channel. It considers product views, wishlist adds, add-to-carts, and completed orders to calculate a conversion rate. The rate is then ranked within the channel to give a normalized score. A higher score means the product turns interest into purchases more successfully, while a lower score indicates weaker conversion performance."374 },375 "sold_quantity": {376 "type": "number",377 "format": "float",378 "minimum": 0,379 "maximum": 1,380 "description": "This score evaluates how many units of a product have been sold for a specific sales channel, compared to other products in the same channel. It calculates total quantities sold and converts them into a percentile rank. A higher score means the product sells in large volumes, while a lower score signals fewer units sold. Products without transactions are assigned a default low score."381 },382 "depth": {383 "type": "number",384 "format": "float",385 "minimum": 0,386 "maximum": 1,387 "description": "This score evaluates how well a product covers different size options for a specific sales channel within its category, while also factoring in the inventory available for each size. It compares the product’s size variety and stock depth against the maximum observed within that category and channel. A higher score means the product offers a broader and better-stocked size range, while a lower score reflects fewer options or limited inventory depth."388 },389 "listing": {390 "type": "number",391 "format": "float",392 "minimum": 0,393 "maximum": 1,394 "description": "This score reflects how recently a product was listed for a specific sales channel. It uses the product’s listing date to calculate how many days have passed since it became available, then normalizes this against other products in the same channel. A higher score means the product is relatively new and fresh on the channel, while a lower score indicates it has been listed for a longer time or lacks valid listing information."395 },396 "discount": {397 "type": "number",398 "format": "float",399 "minimum": 0,400 "maximum": 1,401 "description": "This score reflects the level of discount a product offers for a specific sales channel, relative to others in the channel. It compares the product’s listed price (MRP) to its effective selling price (ESP) and ranks products by discount percentage. It also takes into account Discount Rules. A higher score indicates steeper discounts, while a lower score shows smaller or no discounts. Products without valid price data receive a default low score."402 },403 "cancelled": {404 "type": "number",405 "format": "float",406 "minimum": 0,407 "maximum": 1,408 "description": "This score measures the proportion of orders cancelled by the platform for a specific sales channel. A higher score indicates fewer cancellations, suggesting smoother fulfilment and better operational consistency. A lower score highlights products more prone to cancellations, which may result from inventory mismatches, processing issues, or operational inefficiencies."409 },410 "returns": {411 "type": "number",412 "format": "float",413 "minimum": 0,414 "maximum": 1,415 "description": "This score measures the proportion of orders that were returned for a specific sales channel. It is designed so that a higher score indicates fewer returns relative to total orders, reflecting better product reliability and customer satisfaction. A lower score means the product experiences more returns, which could signal quality issues, mismatched expectations, or customer dissatisfaction."416 },417 "catalogue": {418 "type": "number",419 "format": "float",420 "minimum": 0,421 "maximum": 1,422 "description": "This score evaluates the quality and completeness of a product’s catalogue content for a specific sales channel. It considers the presence of images, videos, and 3D models, along with the length of product descriptions. Balanced image counts, supportive media, and detailed descriptions contribute to a higher score. A higher score means the product is well-presented and informative, while a lower score indicates missing media or insufficient descriptions that may reduce customer confidence."423 },424 "revenue": {425 "type": "number",426 "format": "float",427 "minimum": 0,428 "maximum": 1,429 "description": "This score measures how much revenue a product generates for a specific sales channel, relative to other products in that channel. It looks at the total value of items sold and assigns a percentile rank. A higher score indicates the product drives stronger sales revenue, while a lower score means it contributes less revenue compared to peers. Products with no sales activity receive a default low score."430 }431 }432 },433 "item_code": {434 "type": "string",435 "x-not-enum": true,436 "description": "A unique code assigned to the product item at company and brand level."437 },438 "item_type": {439 "type": "string",440 "enum": [441 "composite",442 "digital",443 "packaging",444 "set",445 "standard",446 "virtual_bundle",447 "physical_bundle"448 ],449 "description": "The type of the product, defining its nature. In case of bundle items type will be (\"virtual_bundle\" or \"physical_bundle\")"450 },451 "medias": {452 "items": {453 "description": "Media information about the product, including metadata, type, URL, and alternative text.",454 "properties": {455 "meta": {456 "type": "object",457 "additionalProperties": true,458 "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."459 },460 "type": {461 "type": "string",462 "enum": [463 "image",464 "video",465 "3d_model"466 ],467 "description": "The type of media."468 },469 "url": {470 "type": "string",471 "description": "The URL where the media can be accessed."472 },473 "alt": {474 "type": "string",475 "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."476 },477 "thumbnail": {478 "type": "string",479 "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."480 }481 },482 "required": [483 "url"484 ],485 "type": "object"486 },487 "type": "array",488 "description": "A list of media items associated with the product, such as images or videos."489 },490 "name": {491 "type": "string",492 "description": "The name of the product."493 },494 "price": {495 "description": "The pricing details of the product.",496 "properties": {497 "effective": {498 "properties": {499 "currency_code": {500 "type": "string",501 "description": "ISO 4217 currency codes",502 "x-not-enum": true503 },504 "currency_symbol": {505 "type": "string"506 },507 "max": {508 "type": "number"509 },510 "min": {511 "type": "number"512 }513 },514 "type": "object"515 },516 "marked": {517 "properties": {518 "currency_code": {519 "type": "string",520 "description": "ISO 4217 currency codes",521 "x-not-enum": true522 },523 "currency_symbol": {524 "type": "string"525 },526 "max": {527 "type": "number"528 },529 "min": {530 "type": "number"531 }532 },533 "type": "object"534 },535 "selling": {536 "properties": {537 "currency_code": {538 "type": "string",539 "description": "ISO 4217 currency codes",540 "x-not-enum": true541 },542 "currency_symbol": {543 "type": "string"544 },545 "max": {546 "type": "number"547 },548 "min": {549 "type": "number"550 }551 },552 "type": "object"553 }554 }555 },556 "product_online_date": {557 "format": "date-time",558 "type": "string",559 "description": "The date and time when the product becomes available online."560 },561 "promo_meta": {562 "type": "object",563 "additionalProperties": true,564 "description": "Metadata related to any promotions associated with the product."565 },566 "rating": {567 "type": "number",568 "description": "The average rating of the product, typically based on customer reviews."569 },570 "rating_count": {571 "type": "integer",572 "description": "The total number of ratings the product has received."573 },574 "sellable": {575 "type": "boolean",576 "description": "Indicates whether the product is available for sale."577 },578 "short_description": {579 "type": "string",580 "description": "A brief description of the product."581 },582 "similars": {583 "items": {584 "type": "string"585 },586 "type": "array",587 "description": "A list of similar products."588 },589 "slug": {590 "type": "string",591 "description": "A URL-friendly string representing the product."592 },593 "teaser_tag": {594 "type": "string",595 "description": "A teaser tag string providing short promotional information about the product."596 },597 "tryouts": {598 "items": {599 "type": "string"600 },601 "type": "array",602 "description": "A list of tryout options or samples available for the product."603 },604 "type": {605 "type": "string",606 "description": "The type or category of the product."607 },608 "uid": {609 "type": "integer",610 "description": "A unique identifier for the product."611 },612 "popularity": {613 "type": "integer",614 "description": "A numerical value indicating the popularity of the product."615 },616 "brand_uid": {617 "type": "integer",618 "description": "The unique identifier for the brand associated with the product."619 },620 "category_uid": {621 "type": "integer",622 "description": "The unique identifier for the category to which the product belongs."623 },624 "verification_status": {625 "type": "string",626 "enum": [627 "pending",628 "verified",629 "rejected"630 ],631 "description": "Verification status of the product."632 },633 "channel_identifier": {634 "type": "string",635 "description": "The identifier for the sales channel through which the product is sold."636 },637 "category_slug": {638 "type": "string",639 "description": "A URL-friendly string representing the product's category."640 },641 "size_guide": {642 "type": "string",643 "description": "A guide or chart providing size information for the product."644 },645 "l3_categories": {646 "type": "array",647 "items": {648 "type": "integer"649 },650 "description": "A list of L3 category IDs of the product."651 },652 "store_ids": {653 "type": "array",654 "items": {655 "type": "integer"656 },657 "description": "A list of store IDs where the product is available."658 },659 "company_ids": {660 "type": "array",661 "items": {662 "type": "integer"663 },664 "description": "A list of company IDs associated with the product."665 },666 "departments": {667 "type": "array",668 "items": {669 "type": "integer"670 },671 "description": "A list of department IDs where the product is categorized."672 },673 "tags": {674 "type": "array",675 "items": {676 "type": "string"677 },678 "description": "A list of tags or keywords associated with the product."679 },680 "l3_category_names": {681 "type": "array",682 "items": {683 "type": "string"684 },685 "description": "A list of names of L3 categories of the product."686 },687 "sizes": {688 "type": "array",689 "items": {690 "type": "string"691 },692 "description": "A list of available sizes for the product."693 },694 "product_group_tag": {695 "type": "array",696 "items": {697 "type": "string"698 },699 "description": "Tags that group the product with other similar products."700 },701 "multi_size": {702 "type": "boolean",703 "description": "Indicates whether the product is available in multiple sizes."704 },705 "is_gift": {706 "type": "boolean",707 "description": "Indicates whether the product can be considered as a gift."708 },709 "is_cod": {710 "type": "boolean",711 "description": "Indicates whether the product is eligible for cash on delivery (COD)."712 },713 "is_dependent": {714 "type": "boolean",715 "description": "Indicates whether the product depends on another product."716 },717 "is_available": {718 "type": "boolean",719 "description": "Indicates whether the product is currently available for purchase."720 },721 "moq": {722 "description": "The order quantity details required to purchase the product.",723 "properties": {724 "increment_unit": {725 "default": 1,726 "description": "The minimum quantity increment in which the item can be purchased.",727 "minimum": 1,728 "type": "integer"729 },730 "maximum": {731 "description": "The maximum quantity allowed for purchase.",732 "type": "integer"733 },734 "minimum": {735 "default": 1,736 "description": "The minimum quantity required for purchase.",737 "minimum": 1,738 "type": "integer"739 }740 },741 "type": "object"742 },743 "seo": {744 "description": "The SEO details related to the product, including metadata for search engine optimization.",745 "properties": {746 "description": {747 "description": "The SEO description of the item",748 "type": "string"749 },750 "title": {751 "description": "The SEO title of the item",752 "type": "string"753 },754 "sitemap": {755 "type": "object",756 "properties": {757 "priority": {758 "type": "number",759 "description": "The SEO priority of the item"760 },761 "frequency": {762 "type": "string",763 "description": "The SEO frequency of the item"764 }765 },766 "required": [767 "priority",768 "frequency"769 ]770 },771 "breadcrumbs": {772 "type": "array",773 "items": {774 "properties": {775 "url": {776 "type": "string"777 },778 "action": {779 "properties": {780 "page": {781 "type": "object",782 "additionalProperties": true783 },784 "type": {785 "type": "string"786 }787 },788 "type": "object",789 "required": [790 "type"791 ]792 }793 },794 "type": "object"795 }796 },797 "meta_tags": {798 "type": "array",799 "items": {800 "properties": {801 "title": {802 "type": "string"803 },804 "items": {805 "items": {806 "properties": {807 "key": {808 "type": "string"809 },810 "value": {811 "type": "string"812 }813 },814 "type": "object",815 "required": [816 "key",817 "value"818 ]819 },820 "type": "array"821 }822 },823 "type": "object",824 "required": [825 "title"826 ]827 }828 },829 "canonical_url": {830 "type": "string"831 }832 },833 "type": "object"834 },835 "variants": {836 "type": "object",837 "additionalProperties": true,838 "description": "An object containing details about the product variants."839 },840 "variant_media": {841 "type": "object",842 "additionalProperties": true,843 "description": "Media items specific to the product variants."844 },845 "variant_group": {846 "type": "object",847 "additionalProperties": true,848 "description": "A group identifier for products that are variants of one another."849 },850 "multi_categories": {851 "type": "array",852 "items": {853 "description": "An object representing the categories that the product belongs to.",854 "properties": {855 "l1": {856 "type": "integer",857 "description": "The ID of the Level 1 (L1) category of the product."858 },859 "l2": {860 "type": "integer",861 "description": "The ID of the Level 2 (L2) category of the product."862 },863 "l3": {864 "type": "integer",865 "description": "The ID of the Level 3 (L3) category of the product."866 },867 "is_active": {868 "type": "boolean",869 "description": "Indicates whether the L3 category of the product is currently active."870 },871 "department": {872 "type": "integer",873 "description": "The department associated with the L3 category of the product."874 }875 },876 "type": "object"877 }878 },879 "template_tag": {880 "type": "string",881 "description": "Tag used for categorizing or templating purposes."882 },883 "net_quantity": {884 "description": "Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.",885 "type": "object",886 "properties": {887 "unit": {888 "type": "string",889 "enum": [890 "L",891 "cm",892 "g",893 "kg",894 "m",895 "ml",896 "nos",897 "pack"898 ],899 "description": "Specifies the unit of measurement for the net quantity."900 },901 "value": {902 "type": "number",903 "description": "The numerical value representing the net quantity of the product."904 }905 }906 },907 "custom_order": {908 "description": "Custom order details for the product.",909 "type": "object",910 "properties": {911 "manufacturing_time_unit": {912 "type": "string",913 "description": "Unit of time for manufacturing (e.g., days, weeks)."914 },915 "is_custom_order": {916 "type": "boolean",917 "description": "Indicates if the product is available for custom orders."918 },919 "manufacturing_time": {920 "type": "integer",921 "description": "Time required for manufacturing in the specified unit."922 }923 },924 "required": [925 "is_custom_order"926 ]927 },928 "country_of_origin": {929 "type": "string",930 "description": "Country where the product is manufactured or sourced from."931 },932 "_custom_json": {933 "type": "object",934 "additionalProperties": true,935 "description": "Custom JSON data associated with the product."936 },937 "identifiers": {938 "type": "array",939 "items": {940 "type": "string"941 },942 "description": "Identifiers associated with the product."943 },944 "item_id": {945 "type": "integer",946 "description": "Unique identifier for the item."947 },948 "_custom_meta": {949 "description": "Custom meta associated with the product.",950 "type": "array",951 "items": {952 "description": "Custom metadata associated with the product.",953 "type": "object",954 "properties": {955 "key": {956 "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",957 "type": "string",958 "minLength": 1,959 "maxLength": 30960 },961 "value": {962 "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",963 "type": "string",964 "minLength": 1,965 "maxLength": 100966 }967 },968 "required": [969 "key",970 "value"971 ]972 }973 },974 "discount_percentage": {975 "type": "integer",976 "description": "The discount applied to the product in percentage."977 },978 "no_of_boxes": {979 "type": "integer",980 "description": "Number of boxes containing the product."981 },982 "created_on": {983 "type": "string",984 "format": "date-time",985 "description": "The date and time when the product was created"986 },987 "modified_on": {988 "type": "string",989 "format": "date-time",990 "description": "The date and time when the product was last modified"991 },992 "sizes_with_identifiers": {993 "type": "array",994 "items": {995 "type": "object",996 "properties": {997 "size": {998 "type": "string",999 "description": "Size of the item."1000 },1001 "identifiers": {1002 "description": "List of identifiers (e.g., SKU codes, GTINs).",1003 "type": "array",1004 "items": {1005 "type": "object",1006 "properties": {1007 "gtin_type": {1008 "description": "Type of GTIN identifier (e.g., SKU, UPC, EAN).",1009 "type": "string"1010 },1011 "gtin_value": {1012 "type": "string",1013 "description": "Value of the GTIN identifier."1014 }1015 },1016 "required": [1017 "gtin_type",1018 "gtin_value"1019 ]1020 }1021 }1022 }1023 },1024 "description": "Sizes along with their identifiers."1025 },1026 "bundle_details": {1027 "type": "array",1028 "description": "An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.",1029 "items": {1030 "type": "object",1031 "properties": {1032 "is_base": {1033 "type": "boolean",1034 "description": "A flag that determines if child product is base product of bundle."1035 },1036 "seller_identifier": {1037 "type": "string",1038 "description": "Seller Identifier of the bundle child product."1039 },1040 "net_quantity": {1041 "type": "number",1042 "description": "Net quantity of the bundle child product."1043 }1044 }1045 }1046 }1047 },1048 "required": [1049 "name",1050 "is_dependent",1051 "uid",1052 "category_uid",1053 "item_code",1054 "multi_size",1055 "brand_uid",1056 "country_of_origin",1057 "item_type",1058 "departments",1059 "slug",1060 "image_nature",1061 "moq",1062 "seo",1063 "is_cod",1064 "is_gift",1065 "is_available",1066 "l3_categories"1067 ]1068 }1069 }1070 }1071 }1072 }1073}
Payload Example
1{2 "event": {3 "trace_id": [4 "wildrider.8d2c94ac-f669-11ee-b89c-be76afdff661"5 ],6 "name": "product",7 "type": "create",8 "version": "2",9 "created_timestamp": 1712664369557,10 "id": "Dd4w9m6Jjq/F+h8iPpU9eThArhRJAkH9uD2y+CMDWhU=",11 "category": "application"12 },13 "company_id": 27070,14 "application_id": [15 "66152d7fae3ebc4cbd68841c",16 "*"17 ],18 "contains": [19 "product"20 ],21 "payload": {22 "product": [23 {24 "uid": 7500005,25 "popularity": 810,26 "brand_uid": 6,27 "category_uid": 6,28 "discount": "10% OFF",29 "discount_percentage": 10,30 "slug": "product-7500005",31 "item_code": "P",32 "net_quantity": {},33 "short_description": "sh",34 "product_online_date": "2024-08-10T07:16:54.345000",35 "verification_status": "pending",36 "description": "main product",37 "channel_identifier": "66b63fb59376243ba8e03696",38 "category_slug": "tanya809142099720242142210",39 "size_guide": "",40 "image_nature": "standard",41 "created_on": "2024-08-09T16:32:03.102000",42 "modified_on": "2024-08-10T07:17:41.073000",43 "name": "product",44 "item_type": "standard",45 "country_of_origin": "India",46 "variant_media": {47 "murray166999799720242142542": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/Q2G4ir7cX-Swatch-url.png"48 },49 "custom_order": {50 "manufacturing_time_unit": "days",51 "is_custom_order": false,52 "manufacturing_time": 053 },54 "attributes": {55 "product_details": "<p>main product</p>",56 "short_description": "sh",57 "brand_name": "Darrick604828449720242141375"58 },59 "variant_group": {60 "murray166999799720242142542": "tanya809142099720242142210-65086549-65634443"61 },62 "moq": {63 "minimum": 1,64 "increment_unit": 165 },66 "seo": {67 "title": "product",68 "description": "sh"69 },70 "l3_categories": [71 672 ],73 "store_ids": [74 375 ],76 "company_ids": [77 378 ],79 "departments": [80 281 ],82 "tags": [],83 "l3_category_names": [84 "Tanya809142099720242142210"85 ],86 "sizes": [87 "OS"88 ],89 "variants": {90 "murray166999799720242142542": [91 "product-myah942395149720242141753-7500001",92 "product3-7500003",93 "product4-7500004"94 ]95 },96 "medias": [97 {98 "type": "image",99 "url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/5VSjZv8NH-product.png",100 "alt": ""101 }102 ],103 "identifiers": [104 "JKWWKJWE"105 ],106 "multi_categories": [107 {108 "l2": 5,109 "l3": 6,110 "l1": 4,111 "is_active": true,112 "department": 2113 }114 ],115 "product_group_tag": [],116 "highlights": [],117 "is_available": true,118 "multi_size": true,119 "is_dependent": false,120 "is_gift": false,121 "is_cod": true,122 "_custom_json": {},123 "scores": {124 "popularity": 0.5,125 "conversion": 0.5,126 "sold_quantity": 0.5,127 "depth": 0.5,128 "listing": 0.5,129 "discount": 0.5,130 "cancelled": 0.5,131 "returns": 0.5,132 "catalogue": 0.5,133 "revenue": 0.5134 },135 "_custom_meta": [],136 "teaser_tag": "Fynd Assured|",137 "sizes_with_identifiers": [138 {139 "size": "OS2",140 "identifiers": [141 {142 "gtin_type": "sku_code",143 "gtin_value": "IDOS2"144 }145 ]146 },147 {148 "size": "OS3",149 "identifiers": [150 {151 "gtin_type": "sku_code",152 "gtin_value": "IDOS3"153 }154 ]155 },156 {157 "size": "OS",158 "identifiers": [159 {160 "gtin_type": "sku_code",161 "gtin_value": "IDOS"162 }163 ]164 }165 ],166 "price": {167 "marked": {168 "min": 1000,169 "max": 1000,170 "currency_code": "INR",171 "currency_symbol": "₹"172 },173 "effective": {174 "min": 900,175 "max": 900,176 "currency_code": "INR",177 "currency_symbol": "₹"178 },179 "selling": {180 "min": 900,181 "max": 900,182 "currency_code": "INR",183 "currency_symbol": "₹"184 }185 }186 }187 ]188 }189}
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
scores
object
The product scores/metrics based on different parameters in a sales channel.
Properties
popularity
number
| value >= 0
| value <= 1
| float
This score captures how trending and popular a product is for a specific sales channel. It evaluates recent customer interactions such as views, wishlist adds, add-to-carts, and orders, applying time-based decay so newer activity matters more. The blended score is ranked within the channel to reflect relative popularity. A higher score means the product is currently engaging more customers, while a lower score shows limited or declining interest.
availability
number
| value >= 0
| value <= 1
| float
This score measures how reliably a product is stocked for a specific sales channel. It compares the product’s current inventory with its highest observed inventory level, adjusted for how inventory is distributed across locations. A higher score means the product is readily available, while a lower score indicates limited stock or frequent stockouts. Products with no meaningful inventory history receive a default low score for interpretation.
conversion
number
| value >= 0
| value <= 1
| float
This score measures how effectively a product converts customer interest into actual orders for a specific sales channel. It considers product views, wishlist adds, add-to-carts, and completed orders to calculate a conversion rate. The rate is then ranked within the channel to give a normalized score. A higher score means the product turns interest into purchases more successfully, while a lower score indicates weaker conversion performance.
sold_quantity
number
| value >= 0
| value <= 1
| float
This score evaluates how many units of a product have been sold for a specific sales channel, compared to other products in the same channel. It calculates total quantities sold and converts them into a percentile rank. A higher score means the product sells in large volumes, while a lower score signals fewer units sold. Products without transactions are assigned a default low score.
depth
number
| value >= 0
| value <= 1
| float
This score evaluates how well a product covers different size options for a specific sales channel within its category, while also factoring in the inventory available for each size. It compares the product’s size variety and stock depth against the maximum observed within that category and channel. A higher score means the product offers a broader and better-stocked size range, while a lower score reflects fewer options or limited inventory depth.
listing
number
| value >= 0
| value <= 1
| float
This score reflects how recently a product was listed for a specific sales channel. It uses the product’s listing date to calculate how many days have passed since it became available, then normalizes this against other products in the same channel. A higher score means the product is relatively new and fresh on the channel, while a lower score indicates it has been listed for a longer time or lacks valid listing information.
discount
number
| value >= 0
| value <= 1
| float
This score reflects the level of discount a product offers for a specific sales channel, relative to others in the channel. It compares the product’s listed price (MRP) to its effective selling price (ESP) and ranks products by discount percentage. It also takes into account Discount Rules. A higher score indicates steeper discounts, while a lower score shows smaller or no discounts. Products without valid price data receive a default low score.
cancelled
number
| value >= 0
| value <= 1
| float
This score measures the proportion of orders cancelled by the platform for a specific sales channel. A higher score indicates fewer cancellations, suggesting smoother fulfilment and better operational consistency. A lower score highlights products more prone to cancellations, which may result from inventory mismatches, processing issues, or operational inefficiencies.
returns
number
| value >= 0
| value <= 1
| float
This score measures the proportion of orders that were returned for a specific sales channel. It is designed so that a higher score indicates fewer returns relative to total orders, reflecting better product reliability and customer satisfaction. A lower score means the product experiences more returns, which could signal quality issues, mismatched expectations, or customer dissatisfaction.
catalogue
number
| value >= 0
| value <= 1
| float
This score evaluates the quality and completeness of a product’s catalogue content for a specific sales channel. It considers the presence of images, videos, and 3D models, along with the length of product descriptions. Balanced image counts, supportive media, and detailed descriptions contribute to a higher score. A higher score means the product is well-presented and informative, while a lower score indicates missing media or insufficient descriptions that may reduce customer confidence.
revenue
number
| value >= 0
| value <= 1
| float
This score measures how much revenue a product generates for a specific sales channel, relative to other products in that channel. It looks at the total value of items sold and assigns a percentile rank. A higher score indicates the product drives stronger sales revenue, while a lower score means it contributes less revenue compared to peers. Products with no sales activity receive a default low score.
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. In case of bundle items type will be ("virtual_bundle" or "physical_bundle")
Enum
medias
array of object
A list of media items associated with the product, such as images or videos.
Array of Properties
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Required
The name of the product.
price
Undefined Type
The pricing details of the product.
Properties
effective
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
marked
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
selling
object
Properties
currency_code
string
ISO 4217 currency codes
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
Required
A URL-friendly string representing the product.
teaser_tag
string
A teaser tag string providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
Required
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
Required
The unique identifier for the brand associated with the product.
category_uid
integer
Required
The unique identifier for the category to which the product belongs.
verification_status
string
Verification status of the product.
Enum
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
Required
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
Required
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Required
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Required
Indicates whether the product can be considered as a gift.
is_cod
boolean
Required
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Required
Indicates whether the product depends on another product.
is_available
boolean
Required
Indicates whether the product is currently available for purchase.
moq
object
Required
The order quantity details required to purchase the product.
Properties
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object
Required
The SEO details related to the product, including metadata for search engine optimization.
Properties
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object
Properties
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object
Array of Properties
url
string
action
object
Properties
page
object
type
string
Required
meta_tags
array of object
Array of Properties
title
string
Required
items
array of object
Array of Properties
key
string
Required
value
string
Required
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object
Array of Properties
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.
Properties
unit
string
Specifies the unit of measurement for the net quantity.
Enum
value
number
The numerical value representing the net quantity of the product.
custom_order
object
Custom order details for the product.
Properties
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Required
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object
Custom meta associated with the product.
Array of Properties
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
no_of_boxes
integer
Number of boxes containing the product.
created_on
string
| date-time
The date and time when the product was created
modified_on
string
| date-time
The date and time when the product was last modified
sizes_with_identifiers
array of object
Sizes along with their identifiers.
Array of Properties
size
string
Size of the item.
identifiers
array of object
List of identifiers (e.g., SKU codes, GTINs).
Array of Properties
gtin_type
string
Required
Type of GTIN identifier (e.g., SKU, UPC, EAN).
gtin_value
string
Required
Value of the GTIN identifier.
bundle_details
array of object
An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.
Array of Properties
is_base
boolean
A flag that determines if child product is base product of bundle.
seller_identifier
string
Seller Identifier of the bundle child product.
net_quantity
number
Net quantity of the bundle child product.
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "properties": {77 "product": {78 "type": "array",79 "items": {80 "type": "object",81 "properties": {82 "attributes": {83 "type": "object",84 "additionalProperties": true,85 "description": "Additional attributes of the product, such as custom properties or features."86 },87 "brand": {88 "properties": {89 "action": {90 "type": "object",91 "description": "Schema to define the Action Object",92 "properties": {93 "type": {94 "type": "string",95 "description": "Type of action to be taken e.g, page.",96 "example": "test"97 },98 "page": {99 "type": "object",100 "description": "Represents the page details used for rendering.",101 "required": [102 "type"103 ],104 "properties": {105 "params": {106 "type": "object",107 "description": "Parameters that should be considered in path.",108 "additionalProperties": {109 "type": "array",110 "items": {111 "type": "string",112 "description": "A string parameter for the action."113 }114 }115 },116 "query": {117 "type": "object",118 "description": "Query parameter if any to be added to the action.",119 "additionalProperties": {120 "type": "array",121 "items": {122 "type": "string",123 "description": "A string query parameter for the action."124 }125 }126 },127 "url": {128 "type": "string",129 "description": "The URL for the action."130 },131 "type": {132 "type": "string",133 "description": "The type of action such as product, products, category, brand.",134 "enum": [135 "about-us",136 "addresses",137 "blog",138 "brands",139 "cards",140 "cart",141 "categories",142 "brand",143 "category",144 "collection",145 "collections",146 "custom",147 "contact-us",148 "external",149 "faq",150 "freshchat",151 "home",152 "notification-settings",153 "orders",154 "page",155 "policy",156 "product",157 "product-request",158 "products",159 "profile",160 "profile-order-shipment",161 "profile-basic",162 "profile-company",163 "profile-emails",164 "profile-phones",165 "rate-us",166 "refer-earn",167 "settings",168 "shared-cart",169 "tnc",170 "track-order",171 "wishlist",172 "sections",173 "form",174 "cart-delivery",175 "cart-payment",176 "cart-review",177 "login",178 "register",179 "shipping-policy",180 "return-policy",181 "order-status",182 "locate-us"183 ]184 }185 }186 },187 "popup": {188 "type": "object",189 "description": "Represents the page details used for rendering.",190 "required": [191 "type"192 ],193 "properties": {194 "params": {195 "type": "object",196 "description": "Parameters that should be considered in path.",197 "additionalProperties": {198 "type": "array",199 "items": {200 "type": "string",201 "description": "A string parameter for the action."202 }203 }204 },205 "query": {206 "type": "object",207 "description": "Query parameter if any to be added to the action.",208 "additionalProperties": {209 "type": "array",210 "items": {211 "type": "string",212 "description": "A string query parameter for the action."213 }214 }215 },216 "url": {217 "type": "string",218 "description": "The URL for the action."219 },220 "type": {221 "type": "string",222 "description": "The type of action such as product, products, category, brand.",223 "enum": [224 "about-us",225 "addresses",226 "blog",227 "brands",228 "cards",229 "cart",230 "categories",231 "brand",232 "category",233 "collection",234 "collections",235 "custom",236 "contact-us",237 "external",238 "faq",239 "freshchat",240 "home",241 "notification-settings",242 "orders",243 "page",244 "policy",245 "product",246 "product-request",247 "products",248 "profile",249 "profile-order-shipment",250 "profile-basic",251 "profile-company",252 "profile-emails",253 "profile-phones",254 "rate-us",255 "refer-earn",256 "settings",257 "shared-cart",258 "tnc",259 "track-order",260 "wishlist",261 "sections",262 "form",263 "cart-delivery",264 "cart-payment",265 "cart-review",266 "login",267 "register",268 "shipping-policy",269 "return-policy",270 "order-status",271 "locate-us"272 ]273 }274 }275 }276 }277 },278 "logo": {279 "description": "Media information about the product, including metadata, type, URL, and alternative text.",280 "properties": {281 "meta": {282 "type": "object",283 "additionalProperties": true,284 "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."285 },286 "type": {287 "type": "string",288 "enum": [289 "image",290 "video",291 "3d_model"292 ],293 "description": "The type of media."294 },295 "url": {296 "type": "string",297 "description": "The URL where the media can be accessed."298 },299 "alt": {300 "type": "string",301 "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."302 },303 "thumbnail": {304 "type": "string",305 "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."306 }307 },308 "required": [309 "url"310 ],311 "type": "object"312 },313 "name": {314 "type": "string"315 },316 "uid": {317 "type": "integer"318 }319 },320 "type": "object",321 "description": "The brand associated with the product."322 },323 "description": {324 "type": "string",325 "description": "A detailed description of the product."326 },327 "discount": {328 "type": "string",329 "description": "The discount applied to the product."330 },331 "has_variant": {332 "type": "boolean",333 "description": "Indicates whether the product has variants, such as different sizes or colors."334 },335 "highlights": {336 "items": {337 "type": "string"338 },339 "type": "array",340 "description": "Key highlights of the product."341 },342 "image_nature": {343 "type": "string",344 "enum": [345 "default",346 "standard"347 ],348 "description": "The nature of the product image, indicating if it's the default or a standard image."349 },350 "scores": {351 "type": "object",352 "description": "The product scores/metrics based on different parameters in a sales channel.",353 "properties": {354 "popularity": {355 "type": "number",356 "format": "float",357 "minimum": 0,358 "maximum": 1,359 "description": "This score captures how trending and popular a product is for a specific sales channel. It evaluates recent customer interactions such as views, wishlist adds, add-to-carts, and orders, applying time-based decay so newer activity matters more. The blended score is ranked within the channel to reflect relative popularity. A higher score means the product is currently engaging more customers, while a lower score shows limited or declining interest."360 },361 "availability": {362 "type": "number",363 "format": "float",364 "minimum": 0,365 "maximum": 1,366 "description": "This score measures how reliably a product is stocked for a specific sales channel. It compares the product’s current inventory with its highest observed inventory level, adjusted for how inventory is distributed across locations. A higher score means the product is readily available, while a lower score indicates limited stock or frequent stockouts. Products with no meaningful inventory history receive a default low score for interpretation."367 },368 "conversion": {369 "type": "number",370 "format": "float",371 "minimum": 0,372 "maximum": 1,373 "description": "This score measures how effectively a product converts customer interest into actual orders for a specific sales channel. It considers product views, wishlist adds, add-to-carts, and completed orders to calculate a conversion rate. The rate is then ranked within the channel to give a normalized score. A higher score means the product turns interest into purchases more successfully, while a lower score indicates weaker conversion performance."374 },375 "sold_quantity": {376 "type": "number",377 "format": "float",378 "minimum": 0,379 "maximum": 1,380 "description": "This score evaluates how many units of a product have been sold for a specific sales channel, compared to other products in the same channel. It calculates total quantities sold and converts them into a percentile rank. A higher score means the product sells in large volumes, while a lower score signals fewer units sold. Products without transactions are assigned a default low score."381 },382 "depth": {383 "type": "number",384 "format": "float",385 "minimum": 0,386 "maximum": 1,387 "description": "This score evaluates how well a product covers different size options for a specific sales channel within its category, while also factoring in the inventory available for each size. It compares the product’s size variety and stock depth against the maximum observed within that category and channel. A higher score means the product offers a broader and better-stocked size range, while a lower score reflects fewer options or limited inventory depth."388 },389 "listing": {390 "type": "number",391 "format": "float",392 "minimum": 0,393 "maximum": 1,394 "description": "This score reflects how recently a product was listed for a specific sales channel. It uses the product’s listing date to calculate how many days have passed since it became available, then normalizes this against other products in the same channel. A higher score means the product is relatively new and fresh on the channel, while a lower score indicates it has been listed for a longer time or lacks valid listing information."395 },396 "discount": {397 "type": "number",398 "format": "float",399 "minimum": 0,400 "maximum": 1,401 "description": "This score reflects the level of discount a product offers for a specific sales channel, relative to others in the channel. It compares the product’s listed price (MRP) to its effective selling price (ESP) and ranks products by discount percentage. It also takes into account Discount Rules. A higher score indicates steeper discounts, while a lower score shows smaller or no discounts. Products without valid price data receive a default low score."402 },403 "cancelled": {404 "type": "number",405 "format": "float",406 "minimum": 0,407 "maximum": 1,408 "description": "This score measures the proportion of orders cancelled by the platform for a specific sales channel. A higher score indicates fewer cancellations, suggesting smoother fulfilment and better operational consistency. A lower score highlights products more prone to cancellations, which may result from inventory mismatches, processing issues, or operational inefficiencies."409 },410 "returns": {411 "type": "number",412 "format": "float",413 "minimum": 0,414 "maximum": 1,415 "description": "This score measures the proportion of orders that were returned for a specific sales channel. It is designed so that a higher score indicates fewer returns relative to total orders, reflecting better product reliability and customer satisfaction. A lower score means the product experiences more returns, which could signal quality issues, mismatched expectations, or customer dissatisfaction."416 },417 "catalogue": {418 "type": "number",419 "format": "float",420 "minimum": 0,421 "maximum": 1,422 "description": "This score evaluates the quality and completeness of a product’s catalogue content for a specific sales channel. It considers the presence of images, videos, and 3D models, along with the length of product descriptions. Balanced image counts, supportive media, and detailed descriptions contribute to a higher score. A higher score means the product is well-presented and informative, while a lower score indicates missing media or insufficient descriptions that may reduce customer confidence."423 },424 "revenue": {425 "type": "number",426 "format": "float",427 "minimum": 0,428 "maximum": 1,429 "description": "This score measures how much revenue a product generates for a specific sales channel, relative to other products in that channel. It looks at the total value of items sold and assigns a percentile rank. A higher score indicates the product drives stronger sales revenue, while a lower score means it contributes less revenue compared to peers. Products with no sales activity receive a default low score."430 }431 }432 },433 "item_code": {434 "type": "string",435 "x-not-enum": true,436 "description": "A unique code assigned to the product item at company and brand level."437 },438 "item_type": {439 "type": "string",440 "enum": [441 "composite",442 "digital",443 "packaging",444 "set",445 "standard",446 "virtual_bundle",447 "physical_bundle"448 ],449 "description": "The type of the product, defining its nature. In case of bundle items type will be (\"virtual_bundle\" or \"physical_bundle\")"450 },451 "medias": {452 "items": {453 "description": "Media information about the product, including metadata, type, URL, and alternative text.",454 "properties": {455 "meta": {456 "type": "object",457 "additionalProperties": true,458 "description": "A metadata object containing additional information about the media, such as dimensions, format, or other relevant details."459 },460 "type": {461 "type": "string",462 "enum": [463 "image",464 "video",465 "3d_model"466 ],467 "description": "The type of media."468 },469 "url": {470 "type": "string",471 "description": "The URL where the media can be accessed."472 },473 "alt": {474 "type": "string",475 "description": "The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed."476 },477 "thumbnail": {478 "type": "string",479 "description": "The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media."480 }481 },482 "required": [483 "url"484 ],485 "type": "object"486 },487 "type": "array",488 "description": "A list of media items associated with the product, such as images or videos."489 },490 "name": {491 "type": "string",492 "description": "The name of the product."493 },494 "price": {495 "description": "The pricing details of the product.",496 "properties": {497 "effective": {498 "properties": {499 "currency_code": {500 "type": "string",501 "description": "ISO 4217 currency codes",502 "x-not-enum": true503 },504 "currency_symbol": {505 "type": "string"506 },507 "max": {508 "type": "number"509 },510 "min": {511 "type": "number"512 }513 },514 "type": "object"515 },516 "marked": {517 "properties": {518 "currency_code": {519 "type": "string",520 "description": "ISO 4217 currency codes",521 "x-not-enum": true522 },523 "currency_symbol": {524 "type": "string"525 },526 "max": {527 "type": "number"528 },529 "min": {530 "type": "number"531 }532 },533 "type": "object"534 },535 "selling": {536 "properties": {537 "currency_code": {538 "type": "string",539 "description": "ISO 4217 currency codes",540 "x-not-enum": true541 },542 "currency_symbol": {543 "type": "string"544 },545 "max": {546 "type": "number"547 },548 "min": {549 "type": "number"550 }551 },552 "type": "object"553 }554 }555 },556 "product_online_date": {557 "format": "date-time",558 "type": "string",559 "description": "The date and time when the product becomes available online."560 },561 "promo_meta": {562 "type": "object",563 "additionalProperties": true,564 "description": "Metadata related to any promotions associated with the product."565 },566 "rating": {567 "type": "number",568 "description": "The average rating of the product, typically based on customer reviews."569 },570 "rating_count": {571 "type": "integer",572 "description": "The total number of ratings the product has received."573 },574 "sellable": {575 "type": "boolean",576 "description": "Indicates whether the product is available for sale."577 },578 "short_description": {579 "type": "string",580 "description": "A brief description of the product."581 },582 "similars": {583 "items": {584 "type": "string"585 },586 "type": "array",587 "description": "A list of similar products."588 },589 "slug": {590 "type": "string",591 "description": "A URL-friendly string representing the product."592 },593 "teaser_tag": {594 "type": "string",595 "description": "A teaser tag string providing short promotional information about the product."596 },597 "tryouts": {598 "items": {599 "type": "string"600 },601 "type": "array",602 "description": "A list of tryout options or samples available for the product."603 },604 "type": {605 "type": "string",606 "description": "The type or category of the product."607 },608 "uid": {609 "type": "integer",610 "description": "A unique identifier for the product."611 },612 "popularity": {613 "type": "integer",614 "description": "A numerical value indicating the popularity of the product."615 },616 "brand_uid": {617 "type": "integer",618 "description": "The unique identifier for the brand associated with the product."619 },620 "category_uid": {621 "type": "integer",622 "description": "The unique identifier for the category to which the product belongs."623 },624 "verification_status": {625 "type": "string",626 "enum": [627 "pending",628 "verified",629 "rejected"630 ],631 "description": "Verification status of the product."632 },633 "channel_identifier": {634 "type": "string",635 "description": "The identifier for the sales channel through which the product is sold."636 },637 "category_slug": {638 "type": "string",639 "description": "A URL-friendly string representing the product's category."640 },641 "size_guide": {642 "type": "string",643 "description": "A guide or chart providing size information for the product."644 },645 "l3_categories": {646 "type": "array",647 "items": {648 "type": "integer"649 },650 "description": "A list of L3 category IDs of the product."651 },652 "store_ids": {653 "type": "array",654 "items": {655 "type": "integer"656 },657 "description": "A list of store IDs where the product is available."658 },659 "company_ids": {660 "type": "array",661 "items": {662 "type": "integer"663 },664 "description": "A list of company IDs associated with the product."665 },666 "departments": {667 "type": "array",668 "items": {669 "type": "integer"670 },671 "description": "A list of department IDs where the product is categorized."672 },673 "tags": {674 "type": "array",675 "items": {676 "type": "string"677 },678 "description": "A list of tags or keywords associated with the product."679 },680 "l3_category_names": {681 "type": "array",682 "items": {683 "type": "string"684 },685 "description": "A list of names of L3 categories of the product."686 },687 "sizes": {688 "type": "array",689 "items": {690 "type": "string"691 },692 "description": "A list of available sizes for the product."693 },694 "product_group_tag": {695 "type": "array",696 "items": {697 "type": "string"698 },699 "description": "Tags that group the product with other similar products."700 },701 "multi_size": {702 "type": "boolean",703 "description": "Indicates whether the product is available in multiple sizes."704 },705 "is_gift": {706 "type": "boolean",707 "description": "Indicates whether the product can be considered as a gift."708 },709 "is_cod": {710 "type": "boolean",711 "description": "Indicates whether the product is eligible for cash on delivery (COD)."712 },713 "is_dependent": {714 "type": "boolean",715 "description": "Indicates whether the product depends on another product."716 },717 "is_available": {718 "type": "boolean",719 "description": "Indicates whether the product is currently available for purchase."720 },721 "moq": {722 "description": "The order quantity details required to purchase the product.",723 "properties": {724 "increment_unit": {725 "default": 1,726 "description": "The minimum quantity increment in which the item can be purchased.",727 "minimum": 1,728 "type": "integer"729 },730 "maximum": {731 "description": "The maximum quantity allowed for purchase.",732 "type": "integer"733 },734 "minimum": {735 "default": 1,736 "description": "The minimum quantity required for purchase.",737 "minimum": 1,738 "type": "integer"739 }740 },741 "type": "object"742 },743 "seo": {744 "description": "The SEO details related to the product, including metadata for search engine optimization.",745 "properties": {746 "description": {747 "description": "The SEO description of the item",748 "type": "string"749 },750 "title": {751 "description": "The SEO title of the item",752 "type": "string"753 },754 "sitemap": {755 "type": "object",756 "properties": {757 "priority": {758 "type": "number",759 "description": "The SEO priority of the item"760 },761 "frequency": {762 "type": "string",763 "description": "The SEO frequency of the item"764 }765 },766 "required": [767 "priority",768 "frequency"769 ]770 },771 "breadcrumbs": {772 "type": "array",773 "items": {774 "properties": {775 "url": {776 "type": "string"777 },778 "action": {779 "properties": {780 "page": {781 "type": "object",782 "additionalProperties": true783 },784 "type": {785 "type": "string"786 }787 },788 "type": "object",789 "required": [790 "type"791 ]792 }793 },794 "type": "object"795 }796 },797 "meta_tags": {798 "type": "array",799 "items": {800 "properties": {801 "title": {802 "type": "string"803 },804 "items": {805 "items": {806 "properties": {807 "key": {808 "type": "string"809 },810 "value": {811 "type": "string"812 }813 },814 "type": "object",815 "required": [816 "key",817 "value"818 ]819 },820 "type": "array"821 }822 },823 "type": "object",824 "required": [825 "title"826 ]827 }828 },829 "canonical_url": {830 "type": "string"831 }832 },833 "type": "object"834 },835 "variants": {836 "type": "object",837 "additionalProperties": true,838 "description": "An object containing details about the product variants."839 },840 "variant_media": {841 "type": "object",842 "additionalProperties": true,843 "description": "Media items specific to the product variants."844 },845 "variant_group": {846 "type": "object",847 "additionalProperties": true,848 "description": "A group identifier for products that are variants of one another."849 },850 "multi_categories": {851 "type": "array",852 "items": {853 "description": "An object representing the categories that the product belongs to.",854 "properties": {855 "l1": {856 "type": "integer",857 "description": "The ID of the Level 1 (L1) category of the product."858 },859 "l2": {860 "type": "integer",861 "description": "The ID of the Level 2 (L2) category of the product."862 },863 "l3": {864 "type": "integer",865 "description": "The ID of the Level 3 (L3) category of the product."866 },867 "is_active": {868 "type": "boolean",869 "description": "Indicates whether the L3 category of the product is currently active."870 },871 "department": {872 "type": "integer",873 "description": "The department associated with the L3 category of the product."874 }875 },876 "type": "object"877 }878 },879 "template_tag": {880 "type": "string",881 "description": "Tag used for categorizing or templating purposes."882 },883 "net_quantity": {884 "description": "Net quantity details for the product, specifying the amount or count of the product included in a package. This is used in product catalogs to convey clear and standardized information to customers.",885 "type": "object",886 "properties": {887 "unit": {888 "type": "string",889 "enum": [890 "L",891 "cm",892 "g",893 "kg",894 "m",895 "ml",896 "nos",897 "pack"898 ],899 "description": "Specifies the unit of measurement for the net quantity."900 },901 "value": {902 "type": "number",903 "description": "The numerical value representing the net quantity of the product."904 }905 }906 },907 "custom_order": {908 "description": "Custom order details for the product.",909 "type": "object",910 "properties": {911 "manufacturing_time_unit": {912 "type": "string",913 "description": "Unit of time for manufacturing (e.g., days, weeks)."914 },915 "is_custom_order": {916 "type": "boolean",917 "description": "Indicates if the product is available for custom orders."918 },919 "manufacturing_time": {920 "type": "integer",921 "description": "Time required for manufacturing in the specified unit."922 }923 },924 "required": [925 "is_custom_order"926 ]927 },928 "country_of_origin": {929 "type": "string",930 "description": "Country where the product is manufactured or sourced from."931 },932 "_custom_json": {933 "type": "object",934 "additionalProperties": true,935 "description": "Custom JSON data associated with the product."936 },937 "identifiers": {938 "type": "array",939 "items": {940 "type": "string"941 },942 "description": "Identifiers associated with the product."943 },944 "item_id": {945 "type": "integer",946 "description": "Unique identifier for the item."947 },948 "_custom_meta": {949 "description": "Custom meta associated with the product.",950 "type": "array",951 "items": {952 "description": "Custom metadata associated with the product.",953 "type": "object",954 "properties": {955 "key": {956 "description": "The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.",957 "type": "string",958 "minLength": 1,959 "maxLength": 30960 },961 "value": {962 "description": "The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.",963 "type": "string",964 "minLength": 1,965 "maxLength": 100966 }967 },968 "required": [969 "key",970 "value"971 ]972 }973 },974 "discount_percentage": {975 "type": "integer",976 "description": "The discount applied to the product in percentage."977 },978 "no_of_boxes": {979 "type": "integer",980 "description": "Number of boxes containing the product."981 },982 "created_on": {983 "type": "string",984 "format": "date-time",985 "description": "The date and time when the product was created"986 },987 "modified_on": {988 "type": "string",989 "format": "date-time",990 "description": "The date and time when the product was last modified"991 },992 "sizes_with_identifiers": {993 "type": "array",994 "items": {995 "type": "object",996 "properties": {997 "size": {998 "type": "string",999 "description": "Size of the item."1000 },1001 "identifiers": {1002 "description": "List of identifiers (e.g., SKU codes, GTINs).",1003 "type": "array",1004 "items": {1005 "type": "object",1006 "properties": {1007 "gtin_type": {1008 "description": "Type of GTIN identifier (e.g., SKU, UPC, EAN).",1009 "type": "string"1010 },1011 "gtin_value": {1012 "type": "string",1013 "description": "Value of the GTIN identifier."1014 }1015 },1016 "required": [1017 "gtin_type",1018 "gtin_value"1019 ]1020 }1021 }1022 }1023 },1024 "description": "Sizes along with their identifiers."1025 },1026 "bundle_details": {1027 "type": "array",1028 "description": "An array of bundle child sku details. This will have child skus along with net quantity used in bundle formation.",1029 "items": {1030 "type": "object",1031 "properties": {1032 "is_base": {1033 "type": "boolean",1034 "description": "A flag that determines if child product is base product of bundle."1035 },1036 "seller_identifier": {1037 "type": "string",1038 "description": "Seller Identifier of the bundle child product."1039 },1040 "net_quantity": {1041 "type": "number",1042 "description": "Net quantity of the bundle child product."1043 }1044 }1045 }1046 }1047 },1048 "required": [1049 "name",1050 "is_dependent",1051 "uid",1052 "category_uid",1053 "item_code",1054 "multi_size",1055 "brand_uid",1056 "country_of_origin",1057 "item_type",1058 "departments",1059 "slug",1060 "image_nature",1061 "moq",1062 "seo",1063 "is_cod",1064 "is_gift",1065 "is_available",1066 "l3_categories"1067 ]1068 }1069 }1070 }1071 }1072 }1073}
Payload Example
1{2 "event": {3 "trace_id": [4 "wildrider.8d2c94ac-f669-11ee-b89c-be76afdff661"5 ],6 "name": "product",7 "type": "update",8 "version": "2",9 "created_timestamp": 1712664369557,10 "id": "Dd4w9m6Jjq/F+h8iPpU9eThArhRJAkH9uD2y+CMDWhU=",11 "category": "application"12 },13 "company_id": 27070,14 "application_id": [15 "66152d7fae3ebc4cbd68841c",16 "*"17 ],18 "contains": [19 "product"20 ],21 "payload": {22 "product": [23 {24 "uid": 7500005,25 "popularity": 810,26 "brand_uid": 6,27 "category_uid": 6,28 "discount": "10% OFF",29 "discount_percentage": 10,30 "slug": "product-7500005",31 "item_code": "P",32 "scores": {33 "popularity": 0.5,34 "conversion": 0.5,35 "sold_quantity": 0.5,36 "depth": 0.5,37 "listing": 0.5,38 "discount": 0.5,39 "cancelled": 0.5,40 "returns": 0.5,41 "catalogue": 0.5,42 "revenue": 0.543 },44 "net_quantity": {},45 "short_description": "sh",46 "product_online_date": "2024-08-10T07:16:54.345000",47 "verification_status": "pending",48 "description": "main product",49 "channel_identifier": "66b63fb59376243ba8e03696",50 "category_slug": "tanya809142099720242142210",51 "size_guide": "",52 "image_nature": "standard",53 "created_on": "2024-08-09T16:32:03.102000",54 "modified_on": "2024-08-10T07:17:41.073000",55 "name": "product",56 "item_type": "standard",57 "country_of_origin": "India",58 "variant_media": {59 "murray166999799720242142542": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/Q2G4ir7cX-Swatch-url.png"60 },61 "custom_order": {62 "manufacturing_time_unit": "days",63 "is_custom_order": false,64 "manufacturing_time": 065 },66 "attributes": {67 "product_details": "<p>main product</p>",68 "short_description": "sh",69 "brand_name": "Darrick604828449720242141375"70 },71 "variant_group": {72 "murray166999799720242142542": "tanya809142099720242142210-65086549-65634443"73 },74 "moq": {75 "minimum": 1,76 "increment_unit": 177 },78 "seo": {79 "title": "product",80 "description": "sh"81 },82 "l3_categories": [83 684 ],85 "store_ids": [86 387 ],88 "company_ids": [89 390 ],91 "departments": [92 293 ],94 "tags": [],95 "l3_category_names": [96 "Tanya809142099720242142210"97 ],98 "sizes": [99 "OS"100 ],101 "all_sizes": [102 "OS"103 ],104 "variants": {105 "murray166999799720242142542": [106 "product-myah942395149720242141753-7500001",107 "product3-7500003",108 "product4-7500004"109 ]110 },111 "medias": [112 {113 "type": "image",114 "url": "https://cdn.pixelbin.io/v2/falling-surf-7c8bb8/sandbx/wrkr/new195vm/products/pictures/item/free/original/5VSjZv8NH-product.png",115 "alt": ""116 }117 ],118 "identifiers": [119 "JKWWKJWE"120 ],121 "multi_categories": [122 {123 "l2": 5,124 "l3": 6,125 "l1": 4,126 "is_active": true,127 "department": 2128 }129 ],130 "product_group_tag": [],131 "highlights": [],132 "is_available": true,133 "multi_size": true,134 "is_dependent": false,135 "is_gift": false,136 "is_cod": true,137 "_custom_json": {},138 "_custom_meta": [],139 "teaser_tag": "Fynd Assured|",140 "sizes_with_identifiers": [141 {142 "size": "OS2",143 "identifiers": [144 {145 "gtin_type": "sku_code",146 "gtin_value": "IDOS2"147 }148 ]149 },150 {151 "size": "OS3",152 "identifiers": [153 {154 "gtin_type": "sku_code",155 "gtin_value": "IDOS3"156 }157 ]158 },159 {160 "size": "OS",161 "identifiers": [162 {163 "gtin_type": "sku_code",164 "gtin_value": "IDOS"165 }166 ]167 }168 ],169 "price": {170 "marked": {171 "min": 1000,172 "max": 1000,173 "currency_code": "INR",174 "currency_symbol": "₹"175 },176 "effective": {177 "min": 900,178 "max": 900,179 "currency_code": "INR",180 "currency_symbol": "₹"181 },182 "selling": {183 "min": 900,184 "max": 900,185 "currency_code": "INR",186 "currency_symbol": "₹"187 }188 }189 }190 ]191 }192}
Payload
Properties
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
category
string
Required
category of the event. If it is at sales channel level or company level
created_timestamp
integer
Required
event generation timestamp in epoch milliseconds
id
string
Required
Unique ID for an event. This id can be used to verifiy if event is already processed by receiver
name
string
Required
Name of the event
trace_id
array of string
Required
internal trace_id for Fynd Platform services
type
string
Required
Type/Action of the event. e.g. create/update/delete
version
string
Required
Version of the event.
payload
object
Required
Properties
product
array of object
Required
Array of Properties
item_id
integer
Required
uid
integer
Required
company_id
integer
Required
brand_uid
integer
Required
item_code
string
Required
Payload Schema JSON
1{2 "type": "object",3 "required": [4 "company_id",5 "contains",6 "event",7 "payload",8 "application_id"9 ],10 "properties": {11 "application_id": {12 "type": [13 "array",14 "string"15 ],16 "description": "sales channel ID for which this event is triggered"17 },18 "company_id": {19 "type": "integer",20 "description": "company ID for which this event is triggered"21 },22 "contains": {23 "type": "array",24 "description": "This array will have all the keys present at root level of 'payload' object",25 "items": {26 "type": "string"27 }28 },29 "event": {30 "type": "object",31 "required": [32 "category",33 "created_timestamp",34 "id",35 "name",36 "trace_id",37 "type",38 "version"39 ],40 "properties": {41 "category": {42 "type": "string",43 "description": "category of the event. If it is at sales channel level or company level"44 },45 "created_timestamp": {46 "type": "integer",47 "description": "event generation timestamp in epoch milliseconds"48 },49 "id": {50 "type": "string",51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"52 },53 "name": {54 "type": "string",55 "description": "Name of the event"56 },57 "trace_id": {58 "type": "array",59 "description": "internal trace_id for Fynd Platform services",60 "items": {61 "type": "string"62 }63 },64 "type": {65 "type": "string",66 "description": "Type/Action of the event. e.g. create/update/delete"67 },68 "version": {69 "type": "string",70 "description": "Version of the event."71 }72 }73 },74 "payload": {75 "type": "object",76 "required": [77 "product"78 ],79 "properties": {80 "product": {81 "type": "array",82 "items": {83 "type": "object",84 "required": [85 "item_id",86 "company_id",87 "brand_uid",88 "item_code",89 "uid"90 ],91 "properties": {92 "item_id": {93 "type": "integer"94 },95 "uid": {96 "type": "integer"97 },98 "company_id": {99 "type": "integer"100 },101 "brand_uid": {102 "type": "integer"103 },104 "item_code": {105 "type": "string"106 }107 }108 }109 }110 }111 }112 }113}
Payload Example
1{2 "event": {3 "trace_id": [4 "wildrider.e2a8d1a6-f660-11ee-b7a5-8edd95bdefe0"5 ],6 "name": "product",7 "type": "delete",8 "version": "2",9 "created_timestamp": 1712660647507,10 "id": "lRlSMKsMiPDJeGTD3I+qQy0HlB5ahVEnD/G/PInOs5I=",11 "category": "application",12 "referer": "fyndx1.de"13 },14 "company_id": 1,15 "application_id": [16 "000000000000000000000001",17 "*"18 ],19 "contains": [20 "product"21 ],22 "payload": {23 "product": [24 {25 "item_id": 7648605,26 "company_id": 1,27 "brand_uid": 65221,28 "item_code": "DKJ789324789",29 "uid": 764860530 }31 ]32 }33}