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/configuration/create/v1
# this event is triggered when configuration is created
application/configuration/update/v1
# this event is triggered when configuration is updated
Payload
Hide
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
Show
payload
object
Required
The payload containing various configuration settings.
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": "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 "description": "The payload containing various configuration settings.",77 "properties": {78 "app": {79 "type": "string",80 "description": "The app associated with the payload."81 },82 "strategy_modified_at": {83 "type": "string",84 "description": "ISO 8601 timestamp of last known modifications to the sales channel feature configuration"85 },86 "business": {87 "type": "string",88 "description": "The business associated with the payload."89 },90 "inventory": {91 "type": "object",92 "description": "The inventory settings.",93 "properties": {94 "company_id": {95 "type": "integer",96 "description": "The ID of the company associated with the inventory."97 },98 "out_of_stock": {99 "type": "boolean",100 "description": "Indicates whether items are out of stock."101 },102 "franchise_enabled": {103 "type": "boolean",104 "description": "Indicates whether franchise operations are enabled."105 },106 "price_strategy": {107 "type": "string",108 "description": "Indicates the pricing strategy value.",109 "enum": [110 "store_prices",111 "price_factory"112 ]113 },114 "international": {115 "type": "boolean",116 "description": "Indicates whether international price factory is enabled or not."117 },118 "brand": {119 "type": "object",120 "description": "The brand settings.",121 "properties": {122 "criteria": {123 "type": "string",124 "description": "The criteria for selecting brands."125 },126 "brands": {127 "type": "array",128 "description": "An array of brand IDs.",129 "items": {130 "type": "integer",131 "description": "The ID of a brand."132 }133 }134 },135 "required": [136 "criteria"137 ]138 },139 "store": {140 "type": "object",141 "description": "The store settings.",142 "properties": {143 "criteria": {144 "type": "string",145 "description": "The criteria for selecting stores."146 },147 "rules": {148 "type": "array",149 "description": "An array of rules.",150 "items": {151 "type": "object",152 "description": "A rule object.",153 "properties": {154 "companies": {155 "type": "array",156 "description": "An array of company IDs.",157 "items": {158 "type": "integer",159 "description": "The ID of a company."160 }161 },162 "brands": {163 "type": "array",164 "description": "An array of brand IDs.",165 "items": {166 "type": "integer",167 "description": "The ID of a brand."168 }169 }170 }171 }172 },173 "stores": {174 "type": "array",175 "description": "An array of store IDs.",176 "items": {177 "type": "integer",178 "description": "The ID of a store."179 }180 }181 },182 "required": [183 "criteria"184 ]185 },186 "image": {187 "type": "array",188 "description": "An array of image URLs.",189 "items": {190 "type": "string",191 "description": "The URL of an image."192 }193 },194 "only_verified_products": {195 "type": "boolean",196 "description": "Indicates whether only verified products are included."197 },198 "category": {199 "type": "object",200 "description": "The category settings.",201 "properties": {202 "criteria": {203 "type": "string",204 "description": "The criteria for selecting categories."205 },206 "categories": {207 "description": "An array of category IDs.",208 "type": "array",209 "items": {210 "type": "integer",211 "description": "The ID of a category."212 }213 }214 }215 },216 "exclude_category": {217 "description": "An array of category IDs to be excluded.",218 "type": "array",219 "items": {220 "type": "integer",221 "description": "The ID of a category."222 }223 },224 "price": {225 "type": "object",226 "description": "The price range settings.",227 "properties": {228 "min": {229 "type": "integer",230 "description": "The minimum value of the price range."231 },232 "max": {233 "type": "integer",234 "description": "The maximum value of the price range."235 }236 },237 "required": [238 "min",239 "max"240 ]241 },242 "discount": {243 "type": "object",244 "description": "The discount settings.",245 "properties": {246 "min": {247 "type": "integer",248 "description": "The minimum value of the discount range."249 },250 "max": {251 "type": "integer",252 "description": "The maximum value of the discount range."253 }254 },255 "required": [256 "min",257 "max"258 ]259 },260 "company_store": {261 "type": "array",262 "description": "An array of company store mappings.",263 "items": {264 "type": "object",265 "required": [266 "store_ids",267 "company_id"268 ],269 "properties": {270 "store_ids": {271 "type": "array",272 "items": {273 "type": "integer"274 },275 "description": "Store UIDs for this company."276 },277 "company_id": {278 "type": "integer",279 "description": "Company UID."280 }281 }282 }283 }284 }285 },286 "search": {287 "type": "object",288 "description": "Configuration settings for search functionality within the application.",289 "properties": {290 "fst_identification": {291 "type": "object",292 "description": "Configuration settings for search query interpretation using the GPT model to deliver more relevant results within the application.",293 "properties": {294 "enabled": {295 "type": "boolean",296 "default": false,297 "description": "Indicates whether search query interpretation is enabled for the application."298 }299 }300 },301 "query_suggestions": {302 "type": "object",303 "description": "Configuration settings for query suggestions powered by the GPT model using the current live catalog within the application.",304 "properties": {305 "enabled": {306 "type": "boolean",307 "default": false,308 "description": "Indicates whether to enable or disable query suggestions powered by the GPT model using the current live catalog within the application."309 },310 "max_limit": {311 "type": "integer",312 "description": "Specifies the maximum number of query suggestions that can be returned."313 }314 }315 },316 "skg_identification": {317 "type": "object",318 "description": "Configuration settings for semantic knowledge graph-based search that leverages AI to understand product relationships, user intent, and contextual meanings to deliver highly accurate and personalized search results within the application.",319 "properties": {320 "enabled": {321 "type": "boolean",322 "default": true,323 "description": "Indicates whether semantic knowledge graph-based search is enabled for the application."324 }325 }326 }327 }328 },329 "authentication": {330 "type": "object",331 "description": "The authentication settings.",332 "properties": {333 "required": {334 "type": "boolean",335 "description": "Indicates whether authentication is required."336 },337 "provider": {338 "type": "string",339 "description": "The authentication provider."340 }341 }342 },343 "article_assignment": {344 "type": "object",345 "description": "The article assignment settings.",346 "properties": {347 "post_order_reassignment": {348 "type": "boolean",349 "description": "Indicates whether post-order reassignment is enabled."350 },351 "enforced_stores": {352 "type": "array",353 "description": "An array of enforced store IDs.",354 "items": {355 "type": "integer",356 "description": "The ID of an enforced store."357 }358 },359 "rules": {360 "type": "object",361 "description": "The rules for article assignment.",362 "properties": {363 "store_priority": {364 "type": "object",365 "description": "The priority settings for stores.",366 "properties": {367 "enabled": {368 "type": "boolean",369 "description": "Indicates whether store priority is enabled."370 },371 "storetype_order": {372 "type": "array",373 "description": "An array of store types in order of priority.",374 "items": {375 "type": "string",376 "description": "The type of a store."377 }378 }379 }380 }381 }382 }383 }384 },385 "reward_points": {386 "type": "object",387 "description": "The reward points settings.",388 "properties": {389 "credit": {390 "type": "object",391 "description": "The credit settings.",392 "properties": {393 "enabled": {394 "type": "boolean",395 "description": "Indicates whether credit is enabled."396 }397 }398 },399 "debit": {400 "type": "object",401 "description": "The debit settings.",402 "properties": {403 "enabled": {404 "type": "boolean",405 "description": "Indicates whether debit is enabled."406 },407 "auto_apply": {408 "type": "boolean",409 "description": "Indicates whether reward points are auto-applied."410 },411 "strategy_channel": {412 "type": "string",413 "description": "The strategy channel for reward points."414 }415 }416 }417 }418 },419 "cart": {420 "type": "object",421 "description": "The cart settings.",422 "properties": {423 "delivery_charges": {424 "type": "object",425 "description": "The delivery charges settings.",426 "properties": {427 "enabled": {428 "type": "boolean",429 "description": "Indicates whether delivery charges are enabled."430 },431 "charges": {432 "type": "array",433 "description": "An array of charge objects.",434 "items": {435 "type": "object",436 "description": "A charge object.",437 "properties": {438 "threshold": {439 "type": "integer",440 "description": "The threshold value."441 },442 "charges": {443 "type": "integer",444 "description": "The charge value."445 }446 }447 }448 }449 }450 },451 "international_delivery_charges": {452 "type": "object",453 "description": "The international delivery charges settings.",454 "properties": {455 "enabled": {456 "type": "boolean",457 "description": "Indicates whether international delivery charges are enabled."458 },459 "charges": {460 "type": "array",461 "description": "An array of charge arrays.",462 "items": {463 "type": "object",464 "description": "A charge object.",465 "properties": {466 "threshold": {467 "type": "integer",468 "description": "The threshold value."469 },470 "charges": {471 "type": "integer",472 "description": "The charge value."473 }474 }475 }476 }477 }478 },479 "pan_card": {480 "type": "object",481 "description": "The PAN card settings.",482 "properties": {483 "enabled": {484 "type": "boolean",485 "description": "Indicates whether PAN card is enabled."486 },487 "cod_threshold_amount": {488 "type": "integer",489 "description": "The COD threshold amount."490 },491 "online_threshold_amount": {492 "type": "integer",493 "description": "The online threshold amount."494 }495 }496 },497 "enabled": {498 "type": "boolean",499 "description": "Indicates whether the cart is enabled."500 },501 "max_cart_items": {502 "type": "integer",503 "description": "The maximum number of items allowed in the cart."504 },505 "min_cart_value": {506 "type": "integer",507 "description": "The minimum cart value allowed."508 },509 "bulk_coupons": {510 "type": "boolean",511 "description": "Indicates whether bulk coupons are enabled."512 },513 "revenue_engine_coupon": {514 "type": "boolean",515 "description": "Indicates whether revenue engine coupon is enabled."516 }517 }518 },519 "payment": {520 "type": "object",521 "description": "The payment settings.",522 "properties": {523 "mode_of_payment": {524 "type": "string",525 "description": "The mode of payment."526 },527 "source": {528 "type": "string",529 "description": "The payment source."530 },531 "enabled": {532 "type": "boolean",533 "description": "Indicates whether the payment method is enabled."534 },535 "callback_url": {536 "type": "object",537 "description": "The callback URL settings.",538 "properties": {539 "app": {540 "type": "string",541 "description": "The callback URL for the app."542 },543 "web": {544 "type": "string",545 "description": "The callback URL for the web."546 }547 }548 },549 "cod_amount_limit": {550 "type": "integer",551 "description": "The COD amount limit."552 },553 "cod_charges": {554 "type": "integer",555 "description": "The COD charges."556 },557 "anonymous_cod": {558 "type": "boolean",559 "description": "Indicates whether anonymous COD is enabled."560 },561 "user_cod_limit": {562 "type": "integer",563 "description": "The user COD limit."564 },565 "methods": {566 "type": "object",567 "description": "The payment methods settings.",568 "properties": {569 "pl": {570 "type": "object",571 "description": "The PL payment method settings.",572 "properties": {573 "enabled": {574 "type": "boolean",575 "description": "Indicates whether the PL payment method is enabled."576 }577 }578 },579 "card": {580 "type": "object",581 "description": "The card payment method settings.",582 "properties": {583 "enabled": {584 "type": "boolean",585 "description": "Indicates whether the card payment method is enabled."586 }587 }588 },589 "nb": {590 "type": "object",591 "description": "The NB payment method settings.",592 "properties": {593 "enabled": {594 "type": "boolean",595 "description": "Indicates whether the NB payment method is enabled."596 }597 }598 },599 "wl": {600 "type": "object",601 "description": "The WL payment method settings.",602 "properties": {603 "enabled": {604 "type": "boolean",605 "description": "Indicates whether the WL payment method is enabled."606 }607 }608 },609 "ps": {610 "type": "object",611 "description": "The PS payment method settings.",612 "properties": {613 "enabled": {614 "type": "boolean",615 "description": "Indicates whether the PS payment method is enabled."616 }617 }618 },619 "upi": {620 "type": "object",621 "description": "The UPI payment method settings.",622 "properties": {623 "enabled": {624 "type": "boolean",625 "description": "Indicates whether the UPI payment method is enabled."626 }627 }628 },629 "qr": {630 "type": "object",631 "description": "The QR payment method settings.",632 "properties": {633 "enabled": {634 "type": "boolean",635 "description": "Indicates whether the QR payment method is enabled."636 }637 }638 },639 "cod": {640 "type": "object",641 "description": "The COD payment method settings.",642 "properties": {643 "enabled": {644 "type": "boolean",645 "description": "Indicates whether the COD payment method is enabled."646 }647 }648 },649 "pp": {650 "type": "object",651 "description": "The PP payment method settings.",652 "properties": {653 "enabled": {654 "type": "boolean",655 "description": "Indicates whether the PP payment method is enabled."656 }657 }658 },659 "jp": {660 "type": "object",661 "description": "The JP payment method settings.",662 "properties": {663 "enabled": {664 "type": "boolean",665 "description": "Indicates whether the JP payment method is enabled."666 }667 }668 },669 "pac": {670 "type": "object",671 "description": "The PAC payment method settings.",672 "properties": {673 "enabled": {674 "type": "boolean",675 "description": "Indicates whether the PAC payment method is enabled."676 }677 }678 },679 "fc": {680 "type": "object",681 "description": "The FC payment method settings.",682 "properties": {683 "enabled": {684 "type": "boolean",685 "description": "Indicates whether the FC payment method is enabled."686 }687 }688 },689 "jiopp": {690 "type": "object",691 "description": "The JIOPP payment method settings.",692 "properties": {693 "enabled": {694 "type": "boolean",695 "description": "Indicates whether the JIOPP payment method is enabled."696 }697 }698 },699 "stripepg": {700 "type": "object",701 "description": "The StripePG payment method settings.",702 "properties": {703 "enabled": {704 "type": "boolean",705 "description": "Indicates whether the StripePG payment method is enabled."706 }707 }708 },709 "juspaypg": {710 "type": "object",711 "description": "The JuspayPG payment method settings.",712 "properties": {713 "enabled": {714 "type": "boolean",715 "description": "Indicates whether the JuspayPG payment method is enabled."716 }717 }718 },719 "payubizpg": {720 "type": "object",721 "description": "The PayubizPG payment method settings.",722 "properties": {723 "enabled": {724 "type": "boolean",725 "description": "Indicates whether the PayubizPG payment method is enabled."726 }727 }728 },729 "payumoneypg": {730 "type": "object",731 "description": "The PayumoneyPG payment method settings.",732 "properties": {733 "enabled": {734 "type": "boolean",735 "description": "Indicates whether the PayumoneyPG payment method is enabled."736 }737 }738 },739 "rupifipg": {740 "type": "object",741 "description": "The RupifiPG payment method settings.",742 "properties": {743 "enabled": {744 "type": "boolean",745 "description": "Indicates whether the RupifiPG payment method is enabled."746 }747 }748 },749 "simpl": {750 "type": "object",751 "description": "The Simpl payment method settings.",752 "properties": {753 "enabled": {754 "type": "boolean",755 "description": "Indicates whether the Simpl payment method is enabled."756 }757 }758 }759 }760 },761 "payment_selection_lock": {762 "type": "object",763 "description": "The payment selection lock settings.",764 "properties": {765 "enabled": {766 "type": "boolean",767 "description": "Indicates whether payment selection lock is enabled."768 },769 "default_options": {770 "type": "string",771 "description": "The default payment options."772 },773 "payment_identifier": {774 "type": "string",775 "description": "The payment identifier."776 }777 }778 }779 },780 "required": [781 "mode_of_payment",782 "source"783 ]784 },785 "order": {786 "type": "object",787 "description": "The order settings.",788 "properties": {789 "enabled": {790 "type": "boolean",791 "description": "Indicates whether orders are enabled."792 },793 "force_reassignment": {794 "type": "boolean",795 "description": "Indicates whether force reassignment is enabled."796 },797 "message": {798 "type": "string",799 "description": "The order message."800 }801 }802 },803 "comms_enabled": {804 "type": "boolean",805 "description": "Indicates whether communications are enabled."806 },807 "communication": {808 "type": "object",809 "description": "The communication settings.",810 "properties": {811 "email": {812 "type": "object",813 "description": "The email settings.",814 "properties": {815 "enabled": {816 "type": "boolean",817 "description": "Indicates whether email communication is enabled."818 }819 }820 },821 "sms": {822 "type": "object",823 "description": "The SMS settings.",824 "properties": {825 "enabled": {826 "type": "boolean",827 "description": "Indicates whether SMS communication is enabled."828 }829 }830 },831 "voice": {832 "type": "object",833 "description": "The voice settings.",834 "properties": {835 "enabled": {836 "type": "boolean",837 "description": "Indicates whether voice communication is enabled."838 }839 }840 }841 }842 },843 "platforms": {844 "type": "array",845 "description": "An array of platform types.",846 "items": {847 "type": "string",848 "description": "The type of a platform."849 }850 },851 "logistics": {852 "type": "object",853 "description": "The logistics settings.",854 "properties": {855 "logistics_by_seller": {856 "type": "boolean",857 "description": "Indicates whether logistics are managed by the seller."858 },859 "serviceability_check": {860 "type": "boolean",861 "description": "Indicates whether serviceability check is enabled."862 },863 "same_day_delivery": {864 "type": "boolean",865 "description": "Indicates whether same day delivery is enabled."866 },867 "dp_assignment": {868 "type": "boolean",869 "description": "Indicates whether DP assignment is enabled."870 }871 }872 },873 "channel_capabilities": {874 "type": "object",875 "description": "Configuration for sales channel capabilities.",876 "properties": {877 "commerce_model": {878 "type": "array",879 "description": "Commerce model types (b2c_d2c, b2b).",880 "items": {881 "type": "string",882 "enum": [883 "b2c_d2c",884 "b2b"885 ]886 }887 },888 "business_format": {889 "type": "array",890 "description": "Business format types.",891 "items": {892 "type": "string",893 "enum": [894 "standard_commerce",895 "quick_commerce",896 "qsr"897 ]898 }899 },900 "seller_model": {901 "type": "string",902 "description": "Seller model for the sales channel.",903 "enum": [904 "single_seller",905 "marketplace",906 "cross_selling"907 ]908 },909 "ordering_sources": {910 "type": "array",911 "description": "Ordering sources for the sales channel.",912 "items": {913 "type": "object",914 "properties": {915 "key": {916 "type": "string",917 "description": "Unique identifier for the ordering source."918 },919 "name": {920 "type": "string",921 "description": "Display name of the ordering source."922 }923 }924 }925 }926 }927 },928 "pii_masking": {929 "type": "object",930 "description": "The PII masking settings.",931 "properties": {932 "enabled": {933 "type": "boolean",934 "description": "Indicates whether PII masking is enabled."935 }936 }937 },938 "security": {939 "type": "object",940 "description": "Configuration for security-related features of the sales channel.",941 "properties": {942 "domains": {943 "type": "array",944 "description": "List of allowed domains for security restrictions.",945 "items": {946 "type": "object",947 "description": "Represents a domain that is permitted for security restrictions, specifying the host and URL scheme.",948 "properties": {949 "host": {950 "type": "string",951 "description": "The host URL for the allowed domain."952 },953 "url_scheme": {954 "type": "string",955 "enum": [956 "http",957 "https"958 ],959 "default": "https",960 "description": "The protocol/scheme to use for the domain. Default is https."961 }962 }963 }964 }965 }966 },967 "tags": {968 "type": "array",969 "description": "An array of tags.",970 "items": {971 "type": "string",972 "description": "A tag."973 }974 },975 "_id": {976 "type": "string",977 "description": "The ID of the payload."978 },979 "modified_by": {980 "type": "string",981 "description": "The user who last modified the payload."982 },983 "created_at": {984 "type": "string",985 "description": "The creation date of the payload."986 },987 "modified_at": {988 "type": "string",989 "description": "The last modification date of the payload."990 },991 "__v": {992 "type": "integer",993 "description": "The version number of the payload."994 }995 },996 "required": [997 "app",998 "business",999 "_id"1000 ]1001 }1002 }1003}
Payload Example
1{2 "application_id": [3 "660d8c6865638760213b78c6",4 "*"5 ],6 "company_id": 3,7 "contains": [8 "app",9 "business",10 "inventory",11 "authentication",12 "article_assignment",13 "reward_points",14 "cart",15 "payment",16 "order",17 "comms_enabled",18 "communication",19 "platforms",20 "logistics",21 "channel_capabilities",22 "pii_masking",23 "security",24 "tags",25 "_id",26 "modified_by",27 "created_at",28 "modified_at",29 "__v"30 ],31 "event": {32 "category": "application",33 "created_timestamp": 1712163944281,34 "id": "hDZA6oUeMD8FStFI5pikYNrcI3BnMO7w9nBzkuOXfaY=",35 "name": "configuration",36 "trace_id": [37 "slingshot.68774491-f1dc-11ee-bd36-63deb585f515"38 ],39 "type": "create",40 "version": "1"41 },42 "payload": {43 "__v": 0,44 "_id": "660d8c6865638760213b78c8",45 "app": "660d8c6865638760213b78c6",46 "article_assignment": {47 "enforced_stores": [],48 "post_order_reassignment": true,49 "rules": {50 "store_priority": {51 "enabled": false,52 "storetype_order": []53 }54 }55 },56 "authentication": {57 "provider": "fynd",58 "required": false59 },60 "business": "retail",61 "cart": {62 "bulk_coupons": false,63 "delivery_charges": {64 "charges": [],65 "enabled": false66 },67 "enabled": true,68 "international_delivery_charges": {69 "charges": [],70 "enabled": false71 },72 "max_cart_items": 50,73 "min_cart_value": 0,74 "pan_card": {75 "cod_threshold_amount": 0,76 "online_threshold_amount": 077 },78 "revenue_engine_coupon": false79 },80 "comms_enabled": true,81 "communication": {82 "email": {83 "enabled": true84 },85 "sms": {86 "enabled": true87 },88 "voice": {89 "enabled": true90 }91 },92 "created_at": "2024-04-03T17:05:44.255Z",93 "inventory": {94 "brand": {95 "brands": [],96 "criteria": "all"97 },98 "category": {99 "categories": [],100 "criteria": "all"101 },102 "company_id": 3,103 "company_store": [],104 "discount": {105 "max": -1,106 "min": 0107 },108 "exclude_category": [],109 "franchise_enabled": false,110 "image": [111 "standard",112 "substandard",113 "default"114 ],115 "only_verified_products": false,116 "out_of_stock": false,117 "price": {118 "max": -1,119 "min": 1120 },121 "store": {122 "criteria": "filter",123 "rules": [124 {125 "brands": [],126 "companies": [127 3128 ]129 }130 ],131 "stores": []132 }133 },134 "logistics": {135 "dp_assignment": true,136 "logistics_by_seller": false,137 "same_day_delivery": true,138 "serviceability_check": true139 },140 "modified_at": "2024-04-03T17:05:44.255Z",141 "modified_by": "8560eb30f83b6cda66aa235d",142 "order": {143 "enabled": true,144 "force_reassignment": false,145 "message": ""146 },147 "payment": {148 "anonymous_cod": false,149 "callback_url": {150 "app": "",151 "web": ""152 },153 "cod_amount_limit": 49000,154 "cod_charges": 0,155 "enabled": true,156 "methods": {157 "card": {158 "enabled": true159 },160 "cod": {161 "enabled": true162 },163 "fc": {164 "enabled": false165 },166 "jiopp": {167 "enabled": false168 },169 "jp": {170 "enabled": false171 },172 "juspaypg": {173 "enabled": false174 },175 "nb": {176 "enabled": true177 },178 "pac": {179 "enabled": false180 },181 "payubizpg": {182 "enabled": false183 },184 "payumoneypg": {185 "enabled": false186 },187 "pl": {188 "enabled": true189 },190 "pp": {191 "enabled": false192 },193 "ps": {194 "enabled": true195 },196 "qr": {197 "enabled": true198 },199 "rupifipg": {200 "enabled": false201 },202 "simpl": {203 "enabled": true204 },205 "stripepg": {206 "enabled": false207 },208 "upi": {209 "enabled": true210 },211 "wl": {212 "enabled": true213 }214 },215 "mode_of_payment": "ECOMM",216 "payment_selection_lock": {217 "default_options": "cod",218 "enabled": false,219 "payment_identifier": "cod"220 },221 "source": "ECOMM",222 "user_cod_limit": 0223 },224 "pii_masking": {225 "enabled": false226 },227 "security": {228 "domains": [229 {230 "host": "example.com",231 "url_scheme": "https"232 },233 {234 "host": "api.example.com",235 "url_scheme": "https"236 }237 ]238 },239 "platforms": [],240 "reward_points": {241 "credit": {242 "enabled": false243 },244 "debit": {245 "auto_apply": false,246 "enabled": false,247 "strategy_channel": ""248 }249 },250 "tags": []251 }252}
Payload
Hide
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
Show
payload
object
Required
The payload containing various configuration settings.
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": "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 "description": "The payload containing various configuration settings.",77 "properties": {78 "app": {79 "type": "string",80 "description": "The app associated with the payload."81 },82 "business": {83 "type": "string",84 "description": "The business associated with the payload."85 },86 "inventory": {87 "type": "object",88 "description": "The inventory settings.",89 "properties": {90 "company_id": {91 "type": "integer",92 "description": "The ID of the company associated with the inventory."93 },94 "out_of_stock": {95 "type": "boolean",96 "description": "Indicates whether items are out of stock."97 },98 "franchise_enabled": {99 "type": "boolean",100 "description": "Indicates whether franchise operations are enabled."101 },102 "price_strategy": {103 "type": "string",104 "description": "Indicates the pricing strategy value.",105 "enum": [106 "store_prices",107 "price_factory"108 ]109 },110 "international": {111 "type": "boolean",112 "description": "Indicates whether international price factory is enabled or not."113 },114 "brand": {115 "type": "object",116 "description": "The brand settings.",117 "properties": {118 "criteria": {119 "type": "string",120 "description": "The criteria for selecting brands."121 },122 "brands": {123 "type": "array",124 "description": "An array of brand IDs.",125 "items": {126 "type": "integer",127 "description": "The ID of a brand."128 }129 }130 },131 "required": [132 "criteria"133 ]134 },135 "store": {136 "type": "object",137 "description": "The store settings.",138 "properties": {139 "criteria": {140 "type": "string",141 "description": "The criteria for selecting stores."142 },143 "rules": {144 "type": "array",145 "description": "An array of rules.",146 "items": {147 "type": "object",148 "description": "A rule object.",149 "properties": {150 "companies": {151 "type": "array",152 "description": "An array of company IDs.",153 "items": {154 "type": "integer",155 "description": "The ID of a company."156 }157 },158 "brands": {159 "type": "array",160 "description": "An array of brand IDs.",161 "items": {162 "type": "integer",163 "description": "The ID of a brand."164 }165 }166 }167 }168 },169 "stores": {170 "type": "array",171 "description": "An array of store IDs.",172 "items": {173 "type": "integer",174 "description": "The ID of a store."175 }176 }177 },178 "required": [179 "criteria"180 ]181 },182 "image": {183 "type": "array",184 "description": "An array of image URLs.",185 "items": {186 "type": "string",187 "description": "The URL of an image."188 }189 },190 "only_verified_products": {191 "type": "boolean",192 "description": "Indicates whether only verified products are included."193 },194 "category": {195 "type": "object",196 "description": "The category settings.",197 "properties": {198 "criteria": {199 "type": "string",200 "description": "The criteria for selecting categories."201 },202 "categories": {203 "description": "An array of category IDs.",204 "type": "array",205 "items": {206 "type": "integer",207 "description": "The ID of a category."208 }209 }210 }211 },212 "exclude_category": {213 "description": "An array of category IDs to be excluded.",214 "type": "array",215 "items": {216 "type": "integer",217 "description": "The ID of a category."218 }219 },220 "price": {221 "type": "object",222 "description": "The price range settings.",223 "properties": {224 "min": {225 "type": "integer",226 "description": "The minimum value of the price range."227 },228 "max": {229 "type": "integer",230 "description": "The maximum value of the price range."231 }232 },233 "required": [234 "min",235 "max"236 ]237 },238 "discount": {239 "type": "object",240 "description": "The discount settings.",241 "properties": {242 "min": {243 "type": "integer",244 "description": "The minimum value of the discount range."245 },246 "max": {247 "type": "integer",248 "description": "The maximum value of the discount range."249 }250 },251 "required": [252 "min",253 "max"254 ]255 },256 "company_store": {257 "type": "array",258 "description": "An array of company store mappings.",259 "items": {260 "type": "object",261 "required": [262 "store_ids",263 "company_id"264 ],265 "properties": {266 "store_ids": {267 "type": "array",268 "items": {269 "type": "integer"270 },271 "description": "Store UIDs for this company."272 },273 "company_id": {274 "type": "integer",275 "description": "Company UID."276 }277 }278 }279 }280 }281 },282 "search": {283 "type": "object",284 "description": "Configuration settings for search functionality within the application.",285 "properties": {286 "fst_identification": {287 "type": "object",288 "description": "Configuration settings for search query interpretation using the GPT model to deliver more relevant results within the application.",289 "properties": {290 "enabled": {291 "type": "boolean",292 "default": false,293 "description": "Indicates whether search query interpretation is enabled for the application."294 }295 }296 },297 "query_suggestions": {298 "type": "object",299 "description": "Configuration settings for query suggestions powered by the GPT model using the current live catalog within the application.",300 "properties": {301 "enabled": {302 "type": "boolean",303 "default": false,304 "description": "Indicates whether to enable or disable query suggestions powered by the GPT model using the current live catalog within the application."305 },306 "max_limit": {307 "type": "integer",308 "description": "Specifies the maximum number of query suggestions that can be returned."309 }310 }311 },312 "skg_identification": {313 "type": "object",314 "description": "Configuration settings for semantic knowledge graph-based search that leverages AI to understand product relationships, user intent, and contextual meanings to deliver highly accurate and personalized search results within the application.",315 "properties": {316 "enabled": {317 "type": "boolean",318 "default": true,319 "description": "Indicates whether semantic knowledge graph-based search is enabled for the application."320 }321 }322 }323 }324 },325 "authentication": {326 "type": "object",327 "description": "The authentication settings.",328 "properties": {329 "required": {330 "type": "boolean",331 "description": "Indicates whether authentication is required."332 },333 "provider": {334 "type": "string",335 "description": "The authentication provider."336 }337 }338 },339 "article_assignment": {340 "type": "object",341 "description": "The article assignment settings.",342 "properties": {343 "post_order_reassignment": {344 "type": "boolean",345 "description": "Indicates whether post-order reassignment is enabled."346 },347 "enforced_stores": {348 "type": "array",349 "description": "An array of enforced store IDs.",350 "items": {351 "type": "integer",352 "description": "The ID of an enforced store."353 }354 },355 "rules": {356 "type": "object",357 "description": "The rules for article assignment.",358 "properties": {359 "store_priority": {360 "type": "object",361 "description": "The priority settings for stores.",362 "properties": {363 "enabled": {364 "type": "boolean",365 "description": "Indicates whether store priority is enabled."366 },367 "storetype_order": {368 "type": "array",369 "description": "An array of store types in order of priority.",370 "items": {371 "type": "string",372 "description": "The type of a store."373 }374 }375 }376 }377 }378 }379 }380 },381 "reward_points": {382 "type": "object",383 "description": "The reward points settings.",384 "properties": {385 "credit": {386 "type": "object",387 "description": "The credit settings.",388 "properties": {389 "enabled": {390 "type": "boolean",391 "description": "Indicates whether credit is enabled."392 }393 }394 },395 "debit": {396 "type": "object",397 "description": "The debit settings.",398 "properties": {399 "enabled": {400 "type": "boolean",401 "description": "Indicates whether debit is enabled."402 },403 "auto_apply": {404 "type": "boolean",405 "description": "Indicates whether reward points are auto-applied."406 },407 "strategy_channel": {408 "type": "string",409 "description": "The strategy channel for reward points."410 }411 }412 }413 }414 },415 "cart": {416 "type": "object",417 "description": "The cart settings.",418 "properties": {419 "delivery_charges": {420 "type": "object",421 "description": "The delivery charges settings.",422 "properties": {423 "tax_rule_id": {424 "type": "string",425 "description": "Defines the applicable GST rate to be applied on delivery charges."426 },427 "sac_code": {428 "type": "string",429 "description": "Specifies the GST service classification code for delivery charges required for e-invoice and e-way bill generation."430 },431 "enabled": {432 "type": "boolean",433 "description": "Indicates whether delivery charges are enabled."434 },435 "charges": {436 "type": "array",437 "description": "An array of charge objects.",438 "items": {439 "type": "object",440 "description": "A charge object.",441 "properties": {442 "threshold": {443 "type": "integer",444 "description": "The threshold value."445 },446 "charges": {447 "type": "integer",448 "description": "The charge value."449 }450 }451 }452 }453 }454 },455 "international_delivery_charges": {456 "type": "object",457 "description": "The international delivery charges settings.",458 "properties": {459 "enabled": {460 "type": "boolean",461 "description": "Indicates whether international delivery charges are enabled."462 },463 "charges": {464 "type": "array",465 "description": "An array of charge arrays.",466 "items": {467 "type": "object",468 "description": "A charge object.",469 "properties": {470 "threshold": {471 "type": "integer",472 "description": "The threshold value."473 },474 "charges": {475 "type": "integer",476 "description": "The charge value."477 }478 }479 }480 }481 }482 },483 "pan_card": {484 "type": "object",485 "description": "The PAN card settings.",486 "properties": {487 "enabled": {488 "type": "boolean",489 "description": "Indicates whether PAN card is enabled."490 },491 "cod_threshold_amount": {492 "type": "integer",493 "description": "The COD threshold amount."494 },495 "online_threshold_amount": {496 "type": "integer",497 "description": "The online threshold amount."498 }499 }500 },501 "enabled": {502 "type": "boolean",503 "description": "Indicates whether the cart is enabled."504 },505 "max_cart_items": {506 "type": "integer",507 "description": "The maximum number of items allowed in the cart."508 },509 "min_cart_value": {510 "type": "integer",511 "description": "The minimum cart value allowed."512 },513 "bulk_coupons": {514 "type": "boolean",515 "description": "Indicates whether bulk coupons are enabled."516 },517 "revenue_engine_coupon": {518 "type": "boolean",519 "description": "Indicates whether revenue engine coupon is enabled."520 },521 "engage_enabled": {522 "type": "boolean",523 "description": "If this is enabled, user can earn and redeem loyalty points for the sales channel."524 },525 "offer_enabled": {526 "type": "boolean",527 "description": "If this is enabled, user can apply coupons and promotions for the sales channel."528 }529 }530 },531 "payment": {532 "type": "object",533 "description": "The payment settings.",534 "properties": {535 "mode_of_payment": {536 "type": "string",537 "description": "The mode of payment."538 },539 "source": {540 "type": "string",541 "description": "The payment source."542 },543 "enabled": {544 "type": "boolean",545 "description": "Indicates whether the payment method is enabled."546 },547 "callback_url": {548 "type": "object",549 "description": "The callback URL settings.",550 "properties": {551 "app": {552 "type": "string",553 "description": "The callback URL for the app."554 },555 "web": {556 "type": "string",557 "description": "The callback URL for the web."558 }559 }560 },561 "cod_amount_limit": {562 "type": "integer",563 "description": "The COD amount limit."564 },565 "cod_charges": {566 "type": "integer",567 "description": "The COD charges."568 },569 "anonymous_cod": {570 "type": "boolean",571 "description": "Indicates whether anonymous COD is enabled."572 },573 "user_cod_limit": {574 "type": "integer",575 "description": "The user COD limit."576 },577 "methods": {578 "type": "object",579 "description": "The payment methods settings.",580 "properties": {581 "pl": {582 "type": "object",583 "description": "The PL payment method settings.",584 "properties": {585 "enabled": {586 "type": "boolean",587 "description": "Indicates whether the PL payment method is enabled."588 }589 }590 },591 "card": {592 "type": "object",593 "description": "The card payment method settings.",594 "properties": {595 "enabled": {596 "type": "boolean",597 "description": "Indicates whether the card payment method is enabled."598 }599 }600 },601 "nb": {602 "type": "object",603 "description": "The NB payment method settings.",604 "properties": {605 "enabled": {606 "type": "boolean",607 "description": "Indicates whether the NB payment method is enabled."608 }609 }610 },611 "wl": {612 "type": "object",613 "description": "The WL payment method settings.",614 "properties": {615 "enabled": {616 "type": "boolean",617 "description": "Indicates whether the WL payment method is enabled."618 }619 }620 },621 "ps": {622 "type": "object",623 "description": "The PS payment method settings.",624 "properties": {625 "enabled": {626 "type": "boolean",627 "description": "Indicates whether the PS payment method is enabled."628 }629 }630 },631 "upi": {632 "type": "object",633 "description": "The UPI payment method settings.",634 "properties": {635 "enabled": {636 "type": "boolean",637 "description": "Indicates whether the UPI payment method is enabled."638 }639 }640 },641 "qr": {642 "type": "object",643 "description": "The QR payment method settings.",644 "properties": {645 "enabled": {646 "type": "boolean",647 "description": "Indicates whether the QR payment method is enabled."648 }649 }650 },651 "cod": {652 "type": "object",653 "description": "The COD payment method settings.",654 "properties": {655 "enabled": {656 "type": "boolean",657 "description": "Indicates whether the COD payment method is enabled."658 }659 }660 },661 "pp": {662 "type": "object",663 "description": "The PP payment method settings.",664 "properties": {665 "enabled": {666 "type": "boolean",667 "description": "Indicates whether the PP payment method is enabled."668 }669 }670 },671 "jp": {672 "type": "object",673 "description": "The JP payment method settings.",674 "properties": {675 "enabled": {676 "type": "boolean",677 "description": "Indicates whether the JP payment method is enabled."678 }679 }680 },681 "pac": {682 "type": "object",683 "description": "The PAC payment method settings.",684 "properties": {685 "enabled": {686 "type": "boolean",687 "description": "Indicates whether the PAC payment method is enabled."688 }689 }690 },691 "fc": {692 "type": "object",693 "description": "The FC payment method settings.",694 "properties": {695 "enabled": {696 "type": "boolean",697 "description": "Indicates whether the FC payment method is enabled."698 }699 }700 },701 "jiopp": {702 "type": "object",703 "description": "The JIOPP payment method settings.",704 "properties": {705 "enabled": {706 "type": "boolean",707 "description": "Indicates whether the JIOPP payment method is enabled."708 }709 }710 },711 "stripepg": {712 "type": "object",713 "description": "The StripePG payment method settings.",714 "properties": {715 "enabled": {716 "type": "boolean",717 "description": "Indicates whether the StripePG payment method is enabled."718 }719 }720 },721 "juspaypg": {722 "type": "object",723 "description": "The JuspayPG payment method settings.",724 "properties": {725 "enabled": {726 "type": "boolean",727 "description": "Indicates whether the JuspayPG payment method is enabled."728 }729 }730 },731 "payubizpg": {732 "type": "object",733 "description": "The PayubizPG payment method settings.",734 "properties": {735 "enabled": {736 "type": "boolean",737 "description": "Indicates whether the PayubizPG payment method is enabled."738 }739 }740 },741 "payumoneypg": {742 "type": "object",743 "description": "The PayumoneyPG payment method settings.",744 "properties": {745 "enabled": {746 "type": "boolean",747 "description": "Indicates whether the PayumoneyPG payment method is enabled."748 }749 }750 },751 "rupifipg": {752 "type": "object",753 "description": "The RupifiPG payment method settings.",754 "properties": {755 "enabled": {756 "type": "boolean",757 "description": "Indicates whether the RupifiPG payment method is enabled."758 }759 }760 },761 "simpl": {762 "type": "object",763 "description": "The Simpl payment method settings.",764 "properties": {765 "enabled": {766 "type": "boolean",767 "description": "Indicates whether the Simpl payment method is enabled."768 }769 }770 }771 }772 },773 "payment_selection_lock": {774 "type": "object",775 "description": "The payment selection lock settings.",776 "properties": {777 "enabled": {778 "type": "boolean",779 "description": "Indicates whether payment selection lock is enabled."780 },781 "default_options": {782 "type": "string",783 "description": "The default payment options."784 },785 "payment_identifier": {786 "type": "string",787 "description": "The payment identifier."788 }789 }790 }791 },792 "required": [793 "mode_of_payment",794 "source"795 ]796 },797 "order": {798 "type": "object",799 "description": "The order settings.",800 "properties": {801 "enabled": {802 "type": "boolean",803 "description": "Indicates whether orders are enabled."804 },805 "force_reassignment": {806 "type": "boolean",807 "description": "Indicates whether force reassignment is enabled."808 },809 "message": {810 "type": "string",811 "description": "The order message."812 },813 "processing_schedule": {814 "description": "Defines the schedule for orders to be processed.",815 "type": "object",816 "properties": {817 "is_scheduled": {818 "type": "boolean",819 "description": "Indicates whether the order processing is scheduled for future."820 },821 "start_after": {822 "type": "object",823 "properties": {824 "days": {825 "type": "integer",826 "description": "Number of days to wait before starting the process."827 },828 "hours": {829 "type": "integer",830 "description": "Number of hours to wait before starting the process."831 },832 "minutes": {833 "type": "integer",834 "description": "Number of minutes to wait before starting the process."835 }836 }837 }838 }839 }840 }841 },842 "comms_enabled": {843 "type": "boolean",844 "description": "Indicates whether communications are enabled."845 },846 "communication": {847 "type": "object",848 "description": "The communication settings.",849 "properties": {850 "email": {851 "type": "object",852 "description": "The email settings.",853 "properties": {854 "enabled": {855 "type": "boolean",856 "description": "Indicates whether email communication is enabled."857 }858 }859 },860 "sms": {861 "type": "object",862 "description": "The SMS settings.",863 "properties": {864 "enabled": {865 "type": "boolean",866 "description": "Indicates whether SMS communication is enabled."867 }868 }869 },870 "voice": {871 "type": "object",872 "description": "The voice settings.",873 "properties": {874 "enabled": {875 "type": "boolean",876 "description": "Indicates whether voice communication is enabled."877 }878 }879 }880 }881 },882 "platforms": {883 "type": "array",884 "description": "An array of platform types.",885 "items": {886 "type": "string",887 "description": "The type of a platform."888 }889 },890 "logistics": {891 "type": "object",892 "description": "The logistics settings.",893 "properties": {894 "logistics_by_seller": {895 "type": "boolean",896 "description": "Indicates whether logistics are managed by the seller."897 },898 "serviceability_check": {899 "type": "boolean",900 "description": "Indicates whether serviceability check is enabled."901 },902 "same_day_delivery": {903 "type": "boolean",904 "description": "Indicates whether same day delivery is enabled."905 },906 "dp_assignment": {907 "type": "boolean",908 "description": "Indicates whether DP assignment is enabled."909 }910 }911 },912 "channel_capabilities": {913 "type": "object",914 "description": "Configuration for sales channel capabilities.",915 "properties": {916 "commerce_model": {917 "type": "array",918 "description": "Commerce model types (b2c_d2c, b2b).",919 "items": {920 "type": "string",921 "enum": [922 "b2c_d2c",923 "b2b"924 ]925 }926 },927 "business_format": {928 "type": "array",929 "description": "Business format types.",930 "items": {931 "type": "string",932 "enum": [933 "standard_commerce",934 "quick_commerce",935 "qsr"936 ]937 }938 },939 "seller_model": {940 "type": "string",941 "description": "Seller model for the sales channel.",942 "enum": [943 "single_seller",944 "marketplace",945 "cross_selling"946 ]947 },948 "ordering_sources": {949 "type": "array",950 "description": "Ordering sources for the sales channel.",951 "items": {952 "type": "object",953 "properties": {954 "key": {955 "type": "string",956 "description": "Unique identifier for the ordering source."957 },958 "name": {959 "type": "string",960 "description": "Display name of the ordering source."961 }962 }963 }964 }965 }966 },967 "pii_masking": {968 "type": "object",969 "description": "The PII masking settings.",970 "properties": {971 "enabled": {972 "type": "boolean",973 "description": "Indicates whether PII masking is enabled."974 }975 }976 },977 "security": {978 "type": "object",979 "description": "Configuration for security-related features of the sales channel.",980 "properties": {981 "domains": {982 "type": "array",983 "description": "List of allowed domains for security restrictions.",984 "items": {985 "type": "object",986 "description": "Represents a domain that is permitted for security restrictions, specifying the host and URL scheme.",987 "properties": {988 "host": {989 "type": "string",990 "description": "The host URL for the allowed domain."991 },992 "url_scheme": {993 "type": "string",994 "enum": [995 "http",996 "https"997 ],998 "default": "https",999 "description": "The protocol/scheme to use for the domain. Default is https."1000 }1001 }1002 }1003 }1004 }1005 },1006 "tags": {1007 "type": "array",1008 "description": "An array of tags.",1009 "items": {1010 "type": "string",1011 "description": "A tag."1012 }1013 },1014 "_id": {1015 "type": "string",1016 "description": "The ID of the payload."1017 },1018 "modified_by": {1019 "type": "string",1020 "description": "The user who last modified the payload."1021 },1022 "created_at": {1023 "type": "string",1024 "description": "The creation date of the payload."1025 },1026 "modified_at": {1027 "type": "string",1028 "description": "The last modification date of the payload."1029 },1030 "__v": {1031 "type": "integer",1032 "description": "The version number of the payload."1033 },1034 "old_payload": {1035 "type": "object",1036 "description": "The old payload schema.",1037 "properties": {1038 "inventory": {1039 "type": "object",1040 "description": "Inventory details.",1041 "properties": {1042 "company_id": {1043 "type": "integer",1044 "description": "The company ID."1045 },1046 "out_of_stock": {1047 "type": "boolean",1048 "description": "Indicates whether the product is out of stock."1049 },1050 "franchise_enabled": {1051 "type": "boolean",1052 "description": "Indicates whether franchise is enabled."1053 },1054 "brand": {1055 "type": "object",1056 "description": "Brand details.",1057 "properties": {1058 "criteria": {1059 "type": "string",1060 "description": "The criteria for the brand."1061 },1062 "brands": {1063 "type": "array",1064 "description": "List of brand IDs.",1065 "items": {1066 "type": "integer",1067 "description": "The ID of a brand."1068 }1069 }1070 },1071 "required": [1072 "criteria"1073 ]1074 },1075 "store": {1076 "type": "object",1077 "description": "Store details.",1078 "properties": {1079 "criteria": {1080 "type": "string",1081 "description": "The criteria for the store."1082 },1083 "rules": {1084 "type": "array",1085 "description": "List of rules for the store.",1086 "items": {1087 "type": "object",1088 "description": "Store rule.",1089 "properties": {1090 "companies": {1091 "type": "array",1092 "description": "List of company IDs for the rule.",1093 "items": {1094 "type": "integer",1095 "description": "The ID of a company."1096 }1097 },1098 "brands": {1099 "type": "array",1100 "description": "List of brand IDs for the rule.",1101 "items": {1102 "type": "integer",1103 "description": "The ID of a brand."1104 }1105 }1106 }1107 }1108 },1109 "stores": {1110 "type": "array",1111 "description": "List of store IDs.",1112 "items": {1113 "type": "integer",1114 "description": "The ID of a store."1115 }1116 }1117 },1118 "required": [1119 "criteria"1120 ]1121 },1122 "image": {1123 "type": "array",1124 "description": "List of image URLs.",1125 "items": {1126 "type": "string",1127 "description": "The URL of an image."1128 }1129 },1130 "only_verified_products": {1131 "type": "boolean",1132 "description": "Indicates whether only verified products are included."1133 },1134 "category": {1135 "type": "object",1136 "description": "Category details.",1137 "properties": {1138 "criteria": {1139 "type": "string",1140 "description": "The criteria for the category."1141 },1142 "categories": {1143 "type": "array",1144 "description": "List of category IDs.",1145 "items": {1146 "type": "integer",1147 "description": "The ID of a category."1148 }1149 }1150 },1151 "required": [1152 "criteria"1153 ]1154 },1155 "exclude_category": {1156 "type": "array",1157 "description": "List of category IDs to be excluded.",1158 "items": {1159 "type": "integer",1160 "description": "The ID of a category."1161 }1162 },1163 "price": {1164 "type": "object",1165 "description": "Price range details.",1166 "properties": {1167 "min": {1168 "type": "integer",1169 "description": "The minimum value of the price range."1170 },1171 "max": {1172 "type": "integer",1173 "description": "The maximum value of the price range."1174 }1175 },1176 "required": [1177 "min",1178 "max"1179 ]1180 },1181 "discount": {1182 "type": "object",1183 "description": "Discount details.",1184 "properties": {1185 "min": {1186 "type": "integer",1187 "description": "The minimum value of the discount."1188 },1189 "max": {1190 "type": "integer",1191 "description": "The maximum value of the discount."1192 }1193 },1194 "required": [1195 "min",1196 "max"1197 ]1198 },1199 "company_store": {1200 "type": "array",1201 "description": "List of company store mappings associated with the payload.",1202 "items": {1203 "type": "object",1204 "required": [1205 "store_ids",1206 "company_id"1207 ],1208 "properties": {1209 "store_ids": {1210 "type": "array",1211 "items": {1212 "type": "integer"1213 },1214 "description": "Store UIDs for this company."1215 },1216 "company_id": {1217 "type": "integer",1218 "description": "Company UID."1219 }1220 }1221 }1222 }1223 }1224 }1225 }1226 }1227 },1228 "required": [1229 "app",1230 "business",1231 "_id",1232 "old_payload"1233 ]1234 }1235 }1236}
Payload Example
1{2 "application_id": [3 "643e93f5ffc8101656a5629b",4 "*"5 ],6 "company_id": 261,7 "contains": [8 "inventory",9 "authentication",10 "article_assignment",11 "reward_points",12 "cart",13 "payment",14 "order",15 "communication",16 "logistics",17 "channel_capabilities",18 "pii_masking",19 "security",20 "_id",21 "app",22 "business",23 "comms_enabled",24 "platforms",25 "tags",26 "modified_by",27 "created_at",28 "modified_at",29 "__v",30 "old_payload"31 ],32 "event": {33 "category": "application",34 "created_timestamp": 1712043192353,35 "id": "8WGM9q/6zYmuYJRawnO2mQDk5iRbybs/x0qB1UUaNXM=",36 "name": "configuration",37 "trace_id": [38 "slingshot.42b54910-f0c3-11ee-aea4-992bbd28a971"39 ],40 "type": "update",41 "version": "1"42 },43 "payload": {44 "__v": 5,45 "_id": "643e93f5ffc8101656a5629d",46 "app": "643e93f5ffc8101656a5629b",47 "article_assignment": {48 "enforced_stores": [],49 "post_order_reassignment": true,50 "rules": {51 "store_priority": {52 "enabled": false,53 "storetype_order": []54 }55 }56 },57 "authentication": {58 "provider": "fynd",59 "required": false60 },61 "business": "retail",62 "cart": {63 "bulk_coupons": false,64 "delivery_charges": {65 "charges": [66 {67 "charges": 0,68 "threshold": 500069 },70 {71 "charges": 0,72 "threshold": 3123073 }74 ],75 "enabled": true76 },77 "enabled": true,78 "international_delivery_charges": {79 "charges": [],80 "enabled": false81 },82 "max_cart_items": 0,83 "min_cart_value": 0,84 "pan_card": {85 "cod_threshold_amount": 50000,86 "enabled": true,87 "online_threshold_amount": 10000088 },89 "revenue_engine_coupon": true90 },91 "comms_enabled": true,92 "communication": {93 "email": {94 "enabled": true95 },96 "sms": {97 "enabled": true98 },99 "voice": {100 "enabled": true101 }102 },103 "created_at": "2023-04-18T12:58:29.147Z",104 "inventory": {105 "brand": {106 "brands": [107 11,108 6939,109 6941,110 6994,111 7043,112 7067,113 7120,114 7157,115 7166,116 10820,117 28702,118 77226,119 79944,120 90910121 ],122 "criteria": "explicit"123 },124 "category": {125 "categories": [],126 "criteria": "all"127 },128 "company_id": 261,129 "company_store": [],130 "discount": {131 "max": -1,132 "min": 0133 },134 "exclude_category": [],135 "franchise_enabled": true,136 "image": [137 "standard"138 ],139 "only_verified_products": false,140 "out_of_stock": false,141 "price": {142 "max": -1,143 "min": 1144 },145 "store": {146 "criteria": "filter",147 "rules": [148 {149 "brands": [150 11,151 6939,152 6941,153 6994,154 7043,155 7067,156 7120,157 7157,158 7166,159 10820,160 28702,161 77226,162 79944,163 90910164 ],165 "companies": [166 261167 ]168 }169 ],170 "stores": []171 }172 },173 "logistics": {174 "dp_assignment": true,175 "logistics_by_seller": false,176 "same_day_delivery": true,177 "serviceability_check": true178 },179 "modified_at": "2024-04-02T07:33:12.335Z",180 "modified_by": "3c8e77cd3ed632e2ab60ce29",181 "old_payload": {182 "inventory": {183 "brand": {184 "brands": [],185 "criteria": "all"186 },187 "category": {188 "categories": [],189 "criteria": "all"190 },191 "company_id": 261,192 "company_store": [],193 "discount": {194 "max": -1,195 "min": 0196 },197 "exclude_category": [],198 "franchise_enabled": true,199 "image": [200 "standard"201 ],202 "only_verified_products": false,203 "out_of_stock": false,204 "price": {205 "max": -1,206 "min": 1207 },208 "store": {209 "criteria": "filter",210 "rules": [211 {212 "brands": [],213 "companies": [214 261215 ]216 }217 ],218 "stores": []219 }220 }221 },222 "order": {223 "enabled": true,224 "force_reassignment": false,225 "message": ""226 },227 "payment": {228 "anonymous_cod": false,229 "callback_url": {230 "app": "",231 "web": ""232 },233 "cod_amount_limit": 49000,234 "cod_charges": 0,235 "enabled": true,236 "methods": {237 "card": {238 "enabled": true239 },240 "cod": {241 "enabled": true242 },243 "fc": {244 "enabled": false245 },246 "jiopp": {247 "enabled": false248 },249 "jp": {250 "enabled": false251 },252 "juspaypg": {253 "enabled": false254 },255 "nb": {256 "enabled": true257 },258 "pac": {259 "enabled": false260 },261 "payubizpg": {262 "enabled": false263 },264 "payumoneypg": {265 "enabled": false266 },267 "pl": {268 "enabled": true269 },270 "pp": {271 "enabled": false272 },273 "ps": {274 "enabled": true275 },276 "qr": {277 "enabled": true278 },279 "rupifipg": {280 "enabled": false281 },282 "simpl": {283 "enabled": true284 },285 "stripepg": {286 "enabled": false287 },288 "upi": {289 "enabled": true290 },291 "wl": {292 "enabled": true293 }294 },295 "mode_of_payment": "ECOMM",296 "payment_selection_lock": {297 "default_options": "cod",298 "enabled": false,299 "payment_identifier": "cod"300 },301 "source": "ECOMM",302 "user_cod_limit": 0303 },304 "pii_masking": {305 "enabled": false306 },307 "security": {308 "domains": [309 {310 "host": "example.com",311 "url_scheme": "https"312 },313 {314 "host": "api.example.com",315 "url_scheme": "https"316 }317 ]318 },319 "platforms": [],320 "reward_points": {321 "credit": {322 "enabled": true323 },324 "debit": {325 "auto_apply": false,326 "enabled": true,327 "strategy_channel": "REWARDS"328 }329 },330 "tags": []331 }332}