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