export = ConfigurationPlatformModel; /** * @typedef CurrencyExchangeResponseV2 * @property {string} base - The 3-letter ISO 4217 code representing the base currency. * @property {string} base_currency_name - The name of the base currency. * @property {number} ttl_seconds - Time in seconds for which the exchange rates * are valid. * @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details. * @property {number} total - Total number of currency exchange items. */ /** * @typedef CurrencyExchangeItem * @property {string} currency_code - 3-letter ISO 4217 exchange currency code. * @property {string} name - Name of the exchange currency * @property {number} rate - Exchange rate of the currency with respect to the * base currency. * @property {string} country_code - ISO 3166 country code. * @property {string} country_name - Name of the country using this currency. * @property {string} subunit - The name of the subunit for the currency. * @property {number} decimal_digits - Number of decimal digits the currency supports. * @property {string} symbol - The symbol of the currency. */ /** * @typedef ApplicationInventory * @property {SearchConfig} [search] * @property {AppInventoryConfig} [inventory] * @property {AuthenticationConfig} [authentication] * @property {ArticleAssignmentConfig} [article_assignment] * @property {RewardPointsConfig} [reward_points] * @property {AppCartConfig} [cart] * @property {AppPaymentConfig} [payment] * @property {AppOrderConfig} [order] * @property {AppLogisticsConfig} [logistics] * @property {PiiMasking} [pii_masking] * @property {ChannelCapabilities} [channel_capabilities] * @property {string[]} [tags] * @property {number} [__v] * @property {string} [business] - Indicates the business type for sales channel * e.g. retail or wholesale * @property {boolean} [comms_enabled] - Shows communication(comms) is enabled * or not for sales channel inventory * @property {CommunicationConfig} [communication] * @property {string[]} [platforms] * @property {string} [_id] - The unique identifier of the sales channel inventory * @property {LoyaltyPointsConfig} [loyalty_points] * @property {string} [app] - Current sales channel ID * @property {string} [created_at] - ISO 8601 timestamp of sales channel * inventory creation * @property {string} [modified_at] - ISO 8601 timestamp of sales channel * inventory updation * @property {string} [modified_by] - User ID of the person who made the latest * changes in the sales channel inventory */ /** * @typedef PiiMasking * @property {boolean} [enabled] */ /** * @typedef ChannelCapabilities * @property {string[]} commerce_model - Commerce model types supported by the * sales channel. Defines whether the channel operates as B2C/D2C * (business-to-consumer/direct-to-consumer) or B2B (business-to-business). * @property {string[]} business_format - Business format types for the sales * channel. Options include standard_commerce for traditional e-commerce, * quick_commerce for rapid delivery models, and qsr for quick service * restaurant operations. * @property {OrderingSources[]} ordering_sources - Represents an ordering * source that can be associated with a sales channel. Ordering sources define * the origin or platform from which orders are placed, enabling tracking and * differentiation of orders based on their source. * @property {string} [seller_model] - Seller model for the sales channel. * single_seller for single seller, marketplace for multiple platforms, * cross_selling for franchise-enabled. */ /** * @typedef OrderingSources * @property {string} key - Unique identifier slug for the ordering source. Used * to reference and identify the source programmatically. * @property {string} name - Human-readable display name of the ordering source. * Shown in UI for easy identification by users. */ /** * @typedef FstIdentification * @property {boolean} [enabled] - Indicates whether search query interpretation * is enabled for the application. */ /** * @typedef SkgIdentification * @property {boolean} [enabled] - Indicates whether semantic knowledge * graph-based search is enabled for the application. */ /** * @typedef QuerySuggestions * @property {boolean} [enabled] - Indicates whether to enable or disable query * suggestions powered by the GPT model using the current live catalog within * the application. * @property {number} [max_limit] - Specifies the maximum number of query * suggestions that can be returned. */ /** * @typedef SearchConfig * @property {FstIdentification} [fst_identification] * @property {QuerySuggestions} [query_suggestions] * @property {SkgIdentification} [skg_identification] */ /** * @typedef AppInventoryConfig * @property {DeliveryStrategy} [delivery_strategy] * @property {InventoryBrand} [brand] * @property {InventoryStore} [store] * @property {InventoryCategory} [category] * @property {InventoryPrice} [price] * @property {InventoryDiscount} [discount] * @property {string} [price_strategy] - Indicates whether price strategy * enabled or not in an application. * @property {boolean} [international] - Indicates whether internation price * factory enabled or not in an application. * @property {boolean} [strategy_change_pending] - Indicates whether price * strategy change is pending or not in an application. * @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration * @property {boolean} [out_of_stock] - Indicates whether out of stock products * are allowed to show up on the website * @property {boolean} [only_verified_products] - Show only verified products * (the ones whose data has been verified by the admin) * @property {boolean} [franchise_enabled] - Allow other businesses (companies) * to consume the current sales channel's inventory and sell products * @property {Object[]} [exclude_category] - List of excluded brands category * @property {string[]} [image] * @property {Object[]} [company_store] - List of selling locations whose * inventory is available to the sales channel for displaying on the website * @property {number} [company_id] */ /** * @typedef InventoryBrand * @property {string} [criteria] - All brands or specific (explicit) brands to * be shown on the website * @property {number[]} [brands] - List of brands */ /** * @typedef InventoryStore * @property {string} [criteria] - All stores or specific (explicit) stores to * be shown on the website * @property {Object[]} [stores] - List of stores * @property {AppStoreRules[]} [rules] - Rules to show which brands or companies * products should be listed on sales channel. */ /** * @typedef AppStoreRules * @property {number[]} [companies] - List of companies whose inventory is * available to the sales channel for displaying on the website * @property {number[]} [brands] - List of brands whose products will be shown * on the website */ /** * @typedef InventoryCategory * @property {string} [criteria] * @property {Object[]} [categories] - List of categories whose products will be * shown on the website */ /** * @typedef InventoryPrice * @property {number} [min] - Minimum inventory price * @property {number} [max] - Maximum inventory price */ /** * @typedef InventoryDiscount * @property {number} [min] - Minimum inventory discount * @property {number} [max] - Maximum inventory discount */ /** * @typedef AuthenticationConfig * @property {boolean} [required] - Shows sales channel inventory authentication * is required or not * @property {string} [provider] - Shows inventory authentication provider */ /** * @typedef ArticleAssignmentConfig * @property {ArticleAssignmentRules} [rules] * @property {boolean} [post_order_reassignment] - Allow post order reassigment of article * @property {number[]} [enforced_stores] */ /** * @typedef ArticleAssignmentRules * @property {StorePriority} [store_priority] */ /** * @typedef StorePriority * @property {boolean} [enabled] - Shows store priority is enabled or disabled * for assignment of article * @property {Object[]} [storetype_order] - List of store types for article * assignment e.g. warehouse, mall, highstreet */ /** * @typedef AppCartConfig * @property {DeliveryCharges} [delivery_charges] * @property {InternationalDeliveryCharges} [international_delivery_charges] * @property {boolean} [enabled] - Shows whether cart configuration is enabled or not * @property {number} [max_cart_items] - Maximum number of items that can be * added to cart by the customer * @property {number} [min_cart_value] - Minimum cart value below which customer * cannot place an order * @property {boolean} [bulk_coupons] - Allow creation of bulk coupons * @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits * together. Default value is false. * @property {PanCardConfig} [pan_card] * @property {boolean} [engage_enabled] - If this is enabled, user can earn and * redeem loyalty points for the sales channel. * @property {boolean} [offer_enabled] - If this is enabled, user can apply * coupons and promotions for the sales channel. */ /** * @typedef InternationalDeliveryCharges * @property {boolean} [enabled] - Allow international delivery charges * @property {Charges[]} [charges] */ /** * @typedef DeliveryCharges * @property {boolean} [enabled] - Allow delivery charges * @property {Charges[]} [charges] - Holds values for delivery charges. */ /** * @typedef Charges * @property {number} [threshold] - The order value below which an extra * delivery fee will be applicable * @property {number} [charges] - Delivery amount to be charged when order value * is below the defined threshold value */ /** * @typedef AppPaymentConfig * @property {CallbackUrl} [callback_url] * @property {Methods} [methods] * @property {PaymentSelectionLock} [payment_selection_lock] * @property {string} [mode_of_payment] - Mode of payment for sales channel * payment, e.g. 'ECOMM'. * @property {string} [source] - Source of the payment mode, e.g. 'ECOMM'. * Default value is FYND. * @property {boolean} [enabled] - Allow payment option within sales channel * @property {number} [cod_amount_limit] - Maximum amount allowed for COD order. * Beyond this, customer cannot opt for COD. * @property {number} [cod_charges] - Extra charge applicable for COD orders * @property {boolean} [anonymous_cod] - Allow cash on delivery for anonymous user * @property {number} [user_cod_limit] */ /** * @typedef CallbackUrl * @property {string} [app] - Payment callback url for app * @property {string} [web] - Payment callback url for web */ /** * @typedef Methods * @property {PaymentModeConfig} [pl] * @property {PaymentModeConfig} [card] * @property {PaymentModeConfig} [nb] * @property {PaymentModeConfig} [wl] * @property {PaymentModeConfig} [ps] * @property {PaymentModeConfig} [upi] * @property {PaymentModeConfig} [qr] * @property {PaymentModeConfig} [cod] * @property {PaymentModeConfig} [pp] * @property {PaymentModeConfig} [jp] * @property {PaymentModeConfig} [pac] * @property {PaymentModeConfig} [fc] * @property {PaymentModeConfig} [jiopp] * @property {PaymentModeConfig} [stripepg] * @property {PaymentModeConfig} [juspaypg] * @property {PaymentModeConfig} [payubizpg] * @property {PaymentModeConfig} [payumoneypg] * @property {PaymentModeConfig} [rupifipg] * @property {PaymentModeConfig} [simpl] */ /** * @typedef PaymentModeConfig * @property {boolean} [enabled] - Shows if a given payment method is enabled or * not, e.g. if 'nb' is enabled, customer can use NetBanking for payment. */ /** * @typedef PaymentSelectionLock * @property {boolean} [enabled] - Shows whether payment mode is restricted to a * specific option, e.g. 'HDFC Netbanking' * @property {string} [default_options] - Shows default payment method, e.g. COD * @property {string} [payment_identifier] - Payment method chosen from default * options, e.g. COD */ /** * @typedef AppOrderConfig * @property {boolean} [enabled] - Allow orders to be accepted from the sales channel * @property {boolean} [force_reassignment] - Allow force reassigning of an order * @property {string} [message] - Reason for reassigning an order * @property {ProcessingSchedule} [processing_schedule] */ /** * @typedef ProcessingSchedule * @property {boolean} [is_scheduled] - Indicates whether the order processing * is scheduled for future. * @property {StartAfter} [start_after] */ /** * @typedef StartAfter * @property {number} [days] - Number of days to wait before starting the process. * @property {number} [hours] - Number of hours to wait before starting the process. * @property {number} [minutes] - Number of minutes to wait before starting the process. */ /** * @typedef AppLogisticsConfig * @property {boolean} [logistics_by_seller] * @property {boolean} [serviceability_check] * @property {boolean} [same_day_delivery] * @property {boolean} [dp_assignment] */ /** * @typedef LoyaltyPointsConfig * @property {boolean} [enabled] - Shows loyalty points is enabled or not enabled * @property {boolean} [auto_apply] - Allow auto apply of loyalty points */ /** * @typedef AppInventoryPartialUpdate * @property {SearchConfig} [search] * @property {RewardPointsConfig} [reward_points] * @property {AppCartConfig} [cart] * @property {AppPaymentConfig} [payment] * @property {LoyaltyPointsConfig} [loyalty_points] * @property {boolean} [comms_enabled] - Shows communication (comms) is enabled * or not for sales channel partial inventory update * @property {CommunicationConfig} [communication] */ /** * @typedef BrandCompanyInfo * @property {string} [company_name] - Name of the company dealing with the brand * @property {number} [company_id] - Numeric ID allotted to a business account */ /** * @typedef CompanyByBrandsRequestSchema * @property {number} brands - Brand UID * @property {string} [search_text] - A search field for finding a company by its name */ /** * @typedef CompanyByBrandsResponseSchema * @property {BrandCompanyInfo[]} [items] * @property {Page} [page] */ /** * @typedef StoreByBrandsRequestSchema * @property {number} [company_id] - Current company ID for current company * stores only. Don't send in case cross-selling (franchise) is enabled. * @property {number} brands - Brand UID * @property {string} [search_text] - Search store by its name or store code */ /** * @typedef StoreByBrandsResponseSchema * @property {BrandStoreInfo[]} [items] * @property {Page} [page] */ /** * @typedef BrandStoreInfo * @property {string} [store_name] - Name of the selling location (store) * @property {number} [store_id] - The unique identifier of the selling location (store) * @property {string} [store_type] - Store type of the brand like warehouse, * high_street, mall * @property {string} [store_code] - Store code of the brand. It is unique for * every brand store. * @property {OptedStoreAddress} [store_address] * @property {OptedCompany} [company] */ /** * @typedef CompanyBrandInfo * @property {string} [name] - Brand name, e.g. Raymonds * @property {number} [value] - Brand UID for identifying the brand * @property {string} [brand_logo_url] - Hosted URL of the brand's logo * @property {string} [brand_banner_url] - Hosted URL of the brand's banner image * @property {string} [brand_banner_portrait_url] - Hosted URL of the brand's * portrait banner */ /** * @typedef BrandsByCompanyResponseSchema * @property {CompanyBrandInfo[]} [brands] */ /** * @typedef ValidationFailedResponseSchema * @property {string} [message] - Response message for failed validation */ /** * @typedef NotFound * @property {string} [message] - Response message for not found * @property {boolean} [success] - Flag for required not successfull. */ /** * @typedef CommunicationConfig * @property {CommsConfig} [email] * @property {CommsConfig} [sms] * @property {CommsConfig} [voice] */ /** * @typedef CommsConfig * @property {boolean} [enabled] - Check current communication channel is enabled */ /** * @typedef PanCardConfig * @property {boolean} [enabled] - If pan card accepting is enabled on cart * @property {number} [cod_threshold_amount] - On which COD order amount pan * card number is expected from customer for order * @property {number} [online_threshold_amount] - On which online payment order * amount pan card number is expected from customer for order */ /** * @typedef CreateApplicationRequestSchema * @property {App} [app] * @property {ApplicationInventory} [configuration] * @property {AppDomain} [domain] */ /** * @typedef CreateAppResponseSchema * @property {Application} [app] * @property {ApplicationInventory} [configuration] */ /** * @typedef ApplicationsResponseSchema * @property {Application[]} [items] * @property {Page} [page] */ /** * @typedef MobileAppConfiguration * @property {boolean} [is_active] - Indicates the availability of the mobile build * @property {string} [_id] - The unique identifier for mobile application configuration * @property {string} [app_name] - Name of the mobile app * @property {LandingImage} [landing_image] * @property {SplashImage} [splash_image] * @property {string} [application] - Application ID of the current sales channel * @property {string} [platform_type] - Device platform for which the mobile app * was built, e.g. android, ios. * @property {string} [created_at] - ISO 8601 timestamp of application * configuration creation * @property {string} [modified_at] - ISO 8601 timestamp of last known * modifications to the app build * @property {number} [__v] - Version key for tracking revisions. Default value is zero. * @property {string} [package_name] - Shows bundle identifier if device * platform is iOS, and directory of the app if device platform is Android */ /** * @typedef LandingImage * @property {string} [aspect_ratio] - Width-to-height ratio of landing image * @property {string} [secure_url] - URL where the landing image is hosted */ /** * @typedef SplashImage * @property {string} [aspect_ratio] - Width-to-height ratio of splash image * @property {string} [secure_url] - URL where the splash image is hosted */ /** * @typedef MobileAppConfigRequestSchema * @property {string} [app_name] - Name of the mobile app * @property {LandingImage} [landing_image] * @property {SplashImage} [splash_image] * @property {boolean} [is_active] - Shows update in mobile app config is active or not */ /** * @typedef BuildVersionHistory * @property {BuildVersion[]} [versions] * @property {string} [latest_available_version_name] - Latest version number of * the mobile build, in dot-decimal notation */ /** * @typedef BuildVersion * @property {string} [_id] - Primary Identifier of the build version. * @property {string} [application] - Application ID of the sales channel * @property {string} [platform_type] - Device platform for which the mobile app * was built, e.g. android, ios. * @property {string} [build_status] - Current progress of the mobile build, * e.g. pending, cancelled, failed, success * @property {string} [version_name] - Version number of the mobile build, in * dot-decimal notation * @property {number} [version_code] - A positive integer used as an internal * version number * @property {LandingImage} [download_url] * @property {string} [created_at] - ISO 8601 timestamp of app creation * @property {string} [modified_at] - ISO 8601 timestamp of last known * modifications to the app build * @property {number} [__v] - Version key for tracking revisions. Default value is zero. */ /** * @typedef AppSupportedCurrency * @property {string} [_id] - The unique identifier of the currency * configuration supported by the application * @property {string[]} [supported_currency] * @property {string} [application] - Alphanumeric ID allotted to an application * (sales channel website) created within a business account. * @property {DefaultCurrency} [default_currency] * @property {string} [created_at] - ISO 8601 timestamp when currency was added * in the list of currencies supported by the sales channel * @property {string} [modified_at] - ISO 8601 timestamp when currency was * updated in the list of currencies supported by the sales channel */ /** * @typedef DefaultCurrency * @property {string} [ref] - The unique identifier of the default currency * @property {string} [code] - 3-character code of the default currency, e.g. * INR, EUR, USD */ /** * @typedef DomainAdd * @property {string} [name] - Full domain name, e.g. uniket.hostx0.de * @property {string} [_id] - The unique identifier of the domain * @property {boolean} [verified] - Domain is verified or not (indicates if A * records and TXT records are correct) * @property {boolean} [is_primary] - Domain is primary or not (indicates if the * domain has been made the main URL of the sales channel) * @property {boolean} [is_shortlink] - Indicates if the domain is a short link * domain (short URL e.g. bitly) * @property {string} [message] - Shows the message shown after adding a domain * successfully, e.g. 'New domain added successfully' * @property {string[]} [txt_records] */ /** * @typedef DomainAddRequestSchema * @property {DomainAdd} [domain] */ /** * @typedef Domain * @property {string} [name] - Full domain name, e.g. newton.com * @property {string} [_id] - The unique identifier of the sales channel domain * @property {boolean} [verified] - Domain is verified or not. TXT and A records * should propagate correctly. * @property {boolean} [is_primary] - Domain is primary or not. Primary domain * is the default/main domain. * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain * @property {boolean} [is_predefined] - Domain is hosting domain or not. * @property {string} [message] */ /** * @typedef DomainsResponseSchema * @property {Domain[]} [domains] */ /** * @typedef UpdateDomain * @property {string} [name] - Full domain name, e.g. zenz.com * @property {string} [_id] - The unique identifier of the domain * @property {boolean} [verified] - Domain is verified or not (indicates if A * records and TXT records are correct) * @property {boolean} [is_primary] - Domain is primary or not (indicates if the * domain has been made the main URL of the sales channel) * @property {boolean} [is_shortlink] - Indicates if the domain is a short link * domain (short URL e.g. bit.ly) */ /** * @typedef UpdateDomainTypeRequestSchema * @property {UpdateDomain} [domain] * @property {string} [action] - Shows domain is made primary domain for the * sales channel or shorlink is created for the sales channel domain */ /** * @typedef DomainStatusRequestSchema * @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de */ /** * @typedef DomainStatus * @property {string} [display] - Shows TXT record and A records for the domain * @property {boolean} [status] - Shows whether TXT record or A records for the * domain are correctly propagating via DNS servers */ /** * @typedef DomainStatusResponseSchema * @property {boolean} [connected] - Check if domain is live and mapped to * appropriate IP of Fynd Servers * @property {DomainStatus[]} [status] */ /** * @typedef DomainSuggestionsRequestSchema * @property {string} [domain_url] - Domain url * @property {boolean} [custom_domain] - Get suggestions for custom domains or * Fynd domains */ /** * @typedef DomainSuggestion * @property {string} name - URL of the custom domain * @property {boolean} [unsupported] - Shows whether TLD domain is supported or not * @property {boolean} is_available - Shows whether the custom domain of your * choice is available or not available * @property {number} [price] - Cost of purchasing a custom domain. Not present * for Fynd domains. * @property {string} [currency] - Custom domain currency. Not present for Fynd domains. */ /** * @typedef DomainSuggestionsResponseSchema * @property {DomainSuggestion[]} [domains] - Domain URL */ /** * @typedef SuccessMessageResponseSchema * @property {boolean} [success] - Shows whether domain was deleted successfully * @property {string} [message] - Success message shown to the user (in a string format) */ /** * @typedef App * @property {string} [company_id] - Numeric ID allotted to a business account * on Fynd Platform. * @property {string} [channel_type] - It indicates different channel types like * store, website-and-mobile-apps. Default value is store * @property {ApplicationAuth} [auth] * @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion * @property {string} [desc] - Detailed description about the sales channel */ /** * @typedef AppDomain * @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com */ /** * @typedef CompaniesResponseSchema * @property {AppInventoryCompanies[]} [items] * @property {Page} [page] */ /** * @typedef AppInventoryCompanies * @property {number} [uid] - UID of the company, e.g. 108 * @property {string} [name] - Name of the company, e.g. Newton Traders * @property {string} [company_type] - Indicates the type of the company, e.g. * franchisee, distributor, etc. */ /** * @typedef StoresResponseSchema * @property {AppInventoryStores[]} [items] * @property {Page} [page] */ /** * @typedef AppInventoryStores * @property {string} [_id] - The unique identifier of the store in the sales * channel inventory * @property {string} [modified_on] - ISO 8601 timestamp of last known updation * to the stores in sales channel inventory * @property {number} [uid] - Sales channel inventory store UID * @property {string} [name] - Name of the store in the sales channel inventory, * e.g. Reebok Mumbai * @property {string} [display_name] - Display name of the sales channel * inventory store (can be different than the actual store name), e.g. Reebok MUM * @property {string} [store_type] - Store type of the sales channel inventory * store, such as mall, warehouse, high_street * @property {string} [store_code] - Store code of the enabled inventory store, * e.g. HS-c9bac. It is unique for every store. * @property {number} [company_id] - Company ID of the selling location (store) * added to the sales channel's inventory * @property {Object} [address] * @property {Object} [integration_type] */ /** * @typedef FilterOrderingStoreRequestSchema * @property {boolean} [all_stores] - Allow all stores from the ordering stores * @property {number[]} [deployed_stores] * @property {string} [q] - Store code or name of the ordering store */ /** * @typedef DeploymentMeta * @property {number[]} [deployed_stores] * @property {boolean} [all_stores] - Allow all stores from the ordering store * @property {boolean} [enabled] - Allow ordering stores for current sales channel * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard * type delivery, store selection is compulsory. For soft type, delivery store * selection is optional. * @property {string} [_id] - The unique identifier of the ordering stores * @property {string} [app] - Alphanumeric ID allotted to an application (sales * channel website) created within a business account * @property {number} [__v] */ /** * @typedef OrderingStoreConfig * @property {DeploymentMeta} [deployment_meta] */ /** * @typedef OrderingStoreSelectRequestSchema * @property {OrderingStoreSelect} ordering_store */ /** * @typedef OrderingStoreSelect * @property {number} uid - Ordering store unique uid. It is required. */ /** * @typedef OtherSellerCompany * @property {number} [uid] - Uid of the seller company * @property {string} [name] - Name of the seller company */ /** * @typedef OtherSellerApplication * @property {string} [name] - Name of the other seller's sales channel * @property {string} [description] - Basic details about the other seller's sales channel * @property {string} [_id] - The unique identifier of the other seller's sales channel * @property {string} [domain] - Domain URL of the other seller's sales channel * @property {OtherSellerCompany} [company] * @property {string} [opt_type] - Inventory opted by the other seller's sales * channel. It can be the current company or stores in the current company. */ /** * @typedef OtherSellerApplications * @property {OtherSellerApplication[]} [items] * @property {Page} [page] */ /** * @typedef OptedApplicationResponseSchema * @property {string} [name] - Name of the other seller's sales channel * @property {string} [description] - Basic details about the other seller's sales channel * @property {string} [_id] - The unique identifier of the other seller's sales channel * @property {string} [domain] - Domain URL of the other seller's sales channel * @property {OptedCompany} [company] * @property {OptedInventory} [opted_inventory] * @property {OptOutInventory} [opt_out_inventory] */ /** * @typedef OptedCompany * @property {number} [uid] - Company UID opted by the other seller's sales * channel in its inventory. It has unique value for the company. * @property {string} [name] - Name of the company opted by the other seller's * sales channel in its inventory * @property {number} [id] - The unique identifier of the opted inventory company */ /** * @typedef OptedInventory * @property {OptType} [opt_type] * @property {Object[]} [items] */ /** * @typedef OptType * @property {string} [key] - Opted type of inventory store. It can be store or company. * @property {string} [display] - Display text of opted type for inventory store */ /** * @typedef OptedStore * @property {string} [name] - Name of the inventory store opted by other * seller's application * @property {string} [store_code] - Store code of the opted inventory store. It * is unique for every store. * @property {string} [_id] - The unique identifier of the opted inventory store * @property {string} [modified_on] - ISO 8601 timestamp of opted inventory store creation * @property {number} [uid] - UID of opted inventory store * @property {OptedStoreAddress} [address] * @property {string} [display_name] - Display name of the opted inventory store * @property {string} [store_type] - Store type of the opted inventory store * like warehouse, high_street, mall. * @property {number} [company_id] - Company ID of the opted inventory store */ /** * @typedef OptOutInventory * @property {number[]} store - List of selling locations (stores) opted out * from the inventory of other seller's application * @property {number[]} company - List of companies opted out from the inventory * of other seller's application */ /** * @typedef TokenResponseSchema * @property {Tokens} [tokens] * @property {string} [_id] - The unique identifier of the token * @property {string} [application] - Alphanumeric ID allotted to the current * application created within the current business account * @property {string} [created_at] - ISO 8601 timestamp of token creation * @property {string} [modified_at] - ISO 8601 timestamp of token updation * @property {number} [__v] - Version key for tracking revisions. Default value is zero. */ /** * @typedef Tokens * @property {Firebase} [firebase] * @property {Moengage} [moengage] * @property {Segment} [segment] * @property {Gtm} [gtm] * @property {Freshchat} [freshchat] * @property {Safetynet} [safetynet] * @property {FyndRewards} [fynd_rewards] * @property {GoogleMap} [google_map] */ /** * @typedef Firebase * @property {Credentials} [credentials] * @property {boolean} [enabled] - Shows whether Firebase integration is enabled * or disabled for the sales channel */ /** * @typedef Credentials * @property {Ios} [ios] * @property {Android} [android] * @property {string} [project_id] - Project ID for Firebase integration. * Project ID is a unique identifier for a project and is used only within the console. * @property {string} [gcm_sender_id] - Google Cloud Manager's Sender ID for * Firebase. It is a unique numerical value which is created when you * configure your project in the Google Developers Console/Google Cloud Console. * @property {string} [application_id] - Alphanumeric ID allotted to the current * application created within the current business account * @property {string} [api_key] - An API key is a unique string that's used to * route requests to your Firebase project when interacting with Firebase. */ /** * @typedef Ios * @property {string} [application_id] - Alphanumeric ID allotted to a sales * channel application created within a business account * @property {string} [api_key] - Firebase secret credential API key for IOS */ /** * @typedef Android * @property {string} [application_id] - Alphanumeric ID allotted to a sales * channel application created within a business account * @property {string} [api_key] - Firebase secret credential API key for Android */ /** * @typedef Moengage * @property {MoengageCredentials} [credentials] * @property {boolean} [enabled] - Shows whether MoEngage integation is enabled * or disabled for the sales channel */ /** * @typedef MoengageCredentials * @property {string} [app_id] - APP ID provided by MoEngage to identify a * specific app. The app_id for your MoEngage account is available on the * MoEngage Dashboard. */ /** * @typedef Segment * @property {SegmentCredentials} [credentials] * @property {boolean} [enabled] - Shows whether Segment integration is enabled * or disabled for the sales channel */ /** * @typedef SegmentCredentials * @property {string} [write_key] - The unique identifier for a source that * tells Segment from which source data is coming from, to which workspace the * data belongs, and which destinations should receive the data. */ /** * @typedef Gtm * @property {GtmCredentials} [credentials] * @property {boolean} [enabled] - Shows whether GTM integration is enabled or * disabled for the sales channel */ /** * @typedef GtmCredentials * @property {string} [api_key] - Secret credential API key for GTM */ /** * @typedef Freshchat * @property {FreshchatCredentials} [credentials] * @property {boolean} [enabled] - Shows whether Freshchat integration is * enabled or disabled for the sales channel */ /** * @typedef FreshchatCredentials * @property {string} [app_id] - The unique app_id of your Freshchat account for * integrating Freshchat with your sales channel * @property {string} [app_key] - The unique app_key of your Freshchat account * for integrating Freshchat with your sales channel * @property {string} [web_token] - Web token used for accessing the Freshchat APIs */ /** * @typedef Safetynet * @property {SafetynetCredentials} [credentials] * @property {boolean} [enabled] - Shows whether Safetynet integration is * enabled or disabled for the sales channel */ /** * @typedef SafetynetCredentials * @property {string} [api_key] - Secret credential API key for Safetynet. This * API key is used for calling the methods of Safetynet APIs. */ /** * @typedef FyndRewards * @property {FyndRewardsCredentials} [credentials] */ /** * @typedef FyndRewardsCredentials * @property {string} [public_key] - Public key for integrating with Fynd rewards. * @property {string} [private_key] - Public key for integrating with Fynd rewards. */ /** * @typedef GoogleMap * @property {boolean} [enabled] - Shows whether Google map integration is enabled or not. * @property {GoogleMapCredentials} [credentials] */ /** * @typedef GoogleMapCredentials * @property {string} [api_key] - Secret API key for Google Maps. A unique * identifier that authenticates requests made to Google Maps API. */ /** * @typedef RewardPointsConfig * @property {Credit} [credit] * @property {Debit} [debit] */ /** * @typedef Credit * @property {boolean} [enabled] - Shows whether reward points should be credited */ /** * @typedef Debit * @property {boolean} [enabled] - Shows whether reward points are available for debit * @property {boolean} [auto_apply] - Allow automatic debit of reward points * @property {string} [strategy_channel] - Strategy channel for debiting reward points */ /** * @typedef ProductDetailFeature * @property {string[]} [similar] - Configuration to show similar products, * other products from same seller, other products in same category, other * products in same price range, etc. * @property {boolean} [seller_selection] - Shows whether the customers can * choose the seller on PDP * @property {boolean} [update_product_meta] - Allow user to update product * meta. Default value is true. * @property {boolean} [request_product] - Indicates whether customers can * request for a product. Default value is false. */ /** * @typedef LaunchPage * @property {string} [page_type] - Type of the launch page * @property {Object} [params] - Launch page params. It can be nullable. * @property {Object} [query] - Query related to launch page. It can be nullable. */ /** * @typedef LandingPageFeature * @property {LaunchPage} [launch_page] * @property {boolean} [continue_as_guest] - Shows whether a guest can checkout * from cart without logging in * @property {string} [login_btn_text] - Shows the text displayed over the login button * @property {boolean} [show_domain_textbox] - Shows whether a textbox for * entering domain is available * @property {boolean} [show_register_btn] - Shows whether register button is * available in the login/landing page */ /** * @typedef ListingPageFeature * @property {string} [sort_on] */ /** * @typedef RegistrationPageFeature * @property {boolean} [ask_store_address] - Shows whether a form to collect the * address of the store, should be displayed upon visiting the website */ /** * @typedef BuyboxFeature * @property {boolean} [show_name] - Allow users to see seller/stores name on * PDP (product detail page). * @property {boolean} [enable_selection] - Allow selection of sellers/stores on * PDP (product detail page). * @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing * between sellers and stores. True indicates seller listing, while False * indicates store listing. */ /** * @typedef DeliveryStrategy * @property {string} [value] - Indicates the delivery strategy value. */ /** * @typedef FulfillmentOption * @property {number} [count] - Total count of available fulfillment options * configured for a specific application. */ /** * @typedef AppFeature * @property {ProductDetailFeature} [product_detail] * @property {LandingPageFeature} [landing_page] * @property {RegistrationPageFeature} [registration_page] * @property {HomePageFeature} [home_page] * @property {CommonFeature} [common] * @property {CartFeature} [cart] * @property {QrFeature} [qr] * @property {PcrFeature} [pcr] * @property {OrderFeature} [order] * @property {SecurityFeature} [security] * @property {BuyboxFeature} [buybox] * @property {DeliveryStrategy} [delivery_strategy] * @property {OrderingSources[]} [ordering_sources] - Represents an ordering * source that can be associated with a sales channel. Ordering sources define * the origin or platform from which orders are placed, enabling tracking and * differentiation of orders based on their source. * @property {string} [price_strategy] - Indicates whether price strategy * enabled or not in an application. * @property {boolean} [international] - Indicates whether internation price * factory enabled or not in an application. * @property {boolean} [strategy_change_pending] - Indicates whether price * strategy change is pending or not in an application. * @property {string} [strategy_modified_at] - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration * @property {FulfillmentOption} [fulfillment_option] * @property {string} [_id] - The unique identifier for the sales channel features * @property {string} [app] - Application ID of the sales channel * @property {string} [created_at] - ISO 8601 timestamp showing the date when * the features were configured * @property {string} [modified_at] - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration * @property {number} [__v] - Version key for tracking revisions. Default value is zero */ /** * @typedef HomePageFeature * @property {boolean} [order_processing] - Shows whether order processing is * enabled or not enabled */ /** * @typedef CommonFeature * @property {CommunicationOptinDialogFeature} [communication_optin_dialog] * @property {DeploymentStoreSelectionFeature} [deployment_store_selection] * @property {ListingPriceFeature} [listing_price] * @property {ListingPageFeature} [listing_page] * @property {CurrencyFeature} [currency] * @property {RevenueEngineFeature} [revenue_engine] * @property {FeedbackFeature} [feedback] * @property {CompareProductsFeature} [compare_products] * @property {RewardPointsConfig} [reward_points] * @property {InternationalShipping} [international_shipping] */ /** * @typedef InternationalShipping * @property {boolean} [enabled] - International shipping is enabled or not. */ /** * @typedef CommunicationOptinDialogFeature * @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled */ /** * @typedef DeploymentStoreSelectionFeature * @property {boolean} [enabled] - Shows whether selection of store (for * deploying the application) is permitted * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard * type delivery, store selection is compulsory. For soft type, delivery store * selection is optional. */ /** * @typedef ListingPriceFeature * @property {string} [value] - Shows which price to display on PLP if one * product has multiple prices (for each size), valid values are 'min', 'max', * 'range'. Default value is range. * @property {string} [sort] - Sorting of listing price with min or max value. * Default value is min. */ /** * @typedef CurrencyFeature * @property {string[]} [value] - 3-letter currency code * @property {string} [type] - If 'explicit', currency formatting shows currency * code with price. For explicit or all currency selection. * @property {string} [default_currency] - 3-letter code of the default currency * used in the application. Default vaule is 'INR'. */ /** * @typedef RevenueEngineFeature * @property {boolean} [enabled] - Enable revenue engine. Default value is false. */ /** * @typedef FeedbackFeature * @property {boolean} [enabled] - Shows whether customer feedback is enabled on * PDP. Default value is false. */ /** * @typedef CompareProductsFeature * @property {boolean} [enabled] - Shows whether product comparison feature is * enabled on PDP */ /** * @typedef CartFeature * @property {boolean} [gst_input] - Shows whether customer is allowed to enter * GST on the cart page for claiming input credits * @property {boolean} [staff_selection] - Shows whether staff selection is * enabled on cart page * @property {boolean} [placing_for_customer] - Shows whether the staff is * placing order on behalf of customer. Default value is true. * @property {boolean} [google_map] - Allow adding of Google Maps. Default value is true. * @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits, * together. Default value is false. */ /** * @typedef QrFeature * @property {boolean} [application] - Shows whether sharing of mobile app via * QR code is allowed. Default value is false. * @property {boolean} [products] - Shows whether sharing product via QR code is * allowed. Default value is false. * @property {boolean} [collections] - Shows whether sharing collection via QR * code is allowed. Default value is false. */ /** * @typedef PcrFeature * @property {boolean} [staff_selection] - Allow staff selection. Default value is false. */ /** * @typedef OrderFeature * @property {boolean} [buy_again] - Allow buy again option for order. Default * value is false. */ /** * @typedef SecurityFeature * @property {AllowedDomain[]} [domains] - List of allowed domains for security * restrictions. */ /** * @typedef AllowedDomain * @property {string} host - The host URL for the allowed domain. * @property {string} [url_scheme] - The protocol/scheme to use for the domain. * Default is https. */ /** * @typedef AppFeatureRequestSchema * @property {AppFeature} [feature] */ /** * @typedef AppFeatureResponseSchema * @property {AppFeature} [feature] */ /** * @typedef Currency * @property {string} [_id] - The unique identifier of the current sales channel * supported currency * @property {boolean} [is_active] - Shows currency is enabled or not in current * sales channel * @property {string} [name] - Name of the currency, e.g Indian Rupee * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR. * @property {string} [created_at] - ISO 8601 timestamp of sales channel support * currency creation * @property {string} [modified_at] - ISO 8601 timestamp of sales channel * support currency updation * @property {number} [decimal_digits] - Acceptable decimal limits for a given * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid * value of a currency. * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹ * @property {string} [country_name] * @property {string} [country_code] */ /** * @typedef ApplicationWebsite * @property {boolean} [enabled] - Shows whether sales channel website URL is * enabled or not * @property {string} [basepath] - Base path for the current sales channel website */ /** * @typedef ApplicationCors * @property {string[]} [domains] */ /** * @typedef ApplicationAuth * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled. */ /** * @typedef ApplicationRedirections * @property {string} [redirect_from] - Old domain url of the sales channel * @property {string} [redirect_to] - New domain URL of the sales channel. Users * will be automatically redirected from old domain to new domain. * @property {string} [type] - It shows domain redirection type. Permanent * redirection is for long time period redirection, and temporary redirection * for a short time period. */ /** * @typedef ApplicationMeta * @property {string} [name] - Indicates to name of application meta * @property {string} [value] - Value related to application meta name */ /** * @typedef SecureUrl * @property {string} [secure_url] - Hosted URL of the image */ /** * @typedef Application * @property {ApplicationWebsite} [website] * @property {ApplicationCors} [cors] * @property {ApplicationAuth} [auth] * @property {string} [description] - It contains detailed information about the * sales channel. * @property {string} [channel_type] - It indicates different channel types like * store, website-and-mobile-apps. Default value is store * @property {number} [cache_ttl] - An integer value that specifies the number * of seconds until the key expires * @property {boolean} [is_internal] - Indicates whether a sales channel is * internal or not * @property {boolean} [is_active] - Indicates sales channel is active or not active * @property {string} [_id] - The unique identifier of the sales channel * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion * @property {string} [owner] - The unique identifier of owner who owns the application * @property {number} [company_id] - Numeric ID allotted to a business account * where the sales channel exists * @property {string} [token] - Random generated fix length string for sales * channel. It is required and auto-generated. * @property {ApplicationRedirections[]} [redirections] * @property {ApplicationMeta[]} [meta] * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation * @property {number} [__v] - Version key for tracking revisions. Default value is zero. * @property {SecureUrl} [banner] * @property {SecureUrl} [logo] * @property {SecureUrl} [favicon] * @property {Domain[]} [domains] * @property {string} [app_type] - It shows application is live or in development mode. * @property {SecureUrl} [mobile_logo] * @property {Domain} [domain] * @property {string} [slug] * @property {string} [mode] * @property {string} [status] * @property {TokenSchema[]} [tokens] * @property {string} [secret] */ /** * @typedef ApplicationById * @property {ApplicationWebsite} [website] * @property {ApplicationCors} [cors] * @property {ApplicationAuth} [auth] * @property {string} [description] - It contains detailed information about the * sales channel. * @property {string} [channel_type] - It indicates different types of channels, * such as store, website, and mobile apps, with 'store' being the default value. * @property {number} [cache_ttl] - An integer value that specifies the number * of seconds until the key expires * @property {boolean} [is_internal] - Indicates whether a sales channel is * internal or not * @property {boolean} [is_active] - Indicates sales channel is active or not active * @property {string} [_id] - The unique identifier of the sales channel * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion * @property {string} [owner] - The unique identifier of owner who owns the application * @property {number} [company_id] - Numeric ID allotted to a business account * where the sales channel exists * @property {string} [token] - Random generated fix length string for sales * channel. It is required and auto-generated. * @property {ApplicationRedirections[]} [redirections] * @property {ApplicationMeta[]} [meta] * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation * @property {number} [__v] - Version key for tracking revisions. Default value is zero. * @property {SecureUrl} [banner] * @property {SecureUrl} [logo] * @property {SecureUrl} [favicon] * @property {Domain[]} [domains] * @property {string} [app_type] - It shows application is live or in development mode. * @property {SecureUrl} [mobile_logo] * @property {Domain} [domain] * @property {string} [slug] * @property {string} [mode] * @property {string} [status] * @property {TokenSchemaID[]} [tokens] * @property {string} [secret] */ /** * @typedef TokenSchemaID * @property {string} [token] * @property {string} [created_by] * @property {string} [created_at] - ISO 8601 timestamp of when token created */ /** * @typedef TokenSchema * @property {string} [token] * @property {Object} [created_by] * @property {string} [created_at] - ISO 8601 timestamp of when token created */ /** * @typedef InvalidPayloadRequestSchema * @property {string} [message] - Error message when request body payload is improper * @property {boolean} [success] - Flag for required not successfull. */ /** * @typedef Page * @property {number} [item_total] - The total number of all items across all pages. * @property {string} [next_id] - The identifier for the next page. * @property {boolean} [has_previous] - Indicates whether there is a previous page. * @property {boolean} [has_next] - Indicates whether there is a next page. * @property {number} [current] - The current page number. * @property {string} type - The type of the page, can be 'cursor' or 'number'. * @property {number} [size] - The number of items per page. * @property {number} [page_size] - The number of items per page. */ /** * @typedef ApplicationInformation * @property {InformationAddress} [address] * @property {InformationSupport} [support] * @property {SocialLinks} [social_links] * @property {Links[]} [links] * @property {string} [copyright_text] - Copyright statement usually seen at the * site's footer * @property {string} [_id] - Unique identifier of the application information * @property {BusinessHighlights[]} [business_highlights] * @property {string} [application] - Alphanumeric ID allotted to a sales * channel application created within a business account * @property {string} [created_at] - ISO 8601 timestamp of creation of the * application information * @property {string} [modified_at] - ISO 8601 timestamp of updation of the * application information * @property {number} [__v] - Version key for tracking revisions. Default value is zero. */ /** * @typedef InformationAddress * @property {InformationLoc} [loc] * @property {string[]} [address_line] - Contact address of the sales channel * @property {InformationPhone[]} [phone] * @property {string} [city] - Name of the city, e.g. Mumbai * @property {string} [country] - Name of the country, e.g. India * @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001 */ /** * @typedef InformationPhone * @property {string} [code] - Country code for contact number, e.g. +91 (for India) * @property {string} [number] - 10-digit mobile number */ /** * @typedef InformationLoc * @property {string} [type] - Country code for contact number, e.g. +91 (for India) * @property {number[]} [coordinates] - 10-digit mobile number */ /** * @typedef InformationSupport * @property {InformationSupportPhone[]} [phone] * @property {InformationSupportEmail[]} [email] * @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM */ /** * @typedef InformationSupportPhone * @property {string} [code] - Country code for contact number, e.g. +91 (for India) * @property {string} [number] - 10-digit mobile number * @property {string} [key] */ /** * @typedef InformationSupportEmail * @property {string} [value] - Value of email. * @property {string} [key] */ /** * @typedef SocialLinks * @property {FacebookLink} [facebook] * @property {InstagramLink} [instagram] * @property {TwitterLink} [twitter] * @property {PinterestLink} [pinterest] * @property {GooglePlusLink} [google_plus] * @property {YoutubeLink} [youtube] * @property {LinkedInLink} [linked_in] * @property {VimeoLink} [vimeo] * @property {BlogLink} [blog_link] */ /** * @typedef FacebookLink * @property {string} [title] - Name of the social media platform, e.g. Facebook * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Facebook page */ /** * @typedef InstagramLink * @property {string} [title] - Name of the social media platform, e.g. Instagram * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Instagram page */ /** * @typedef TwitterLink * @property {string} [title] - Name of the social media platform, e.g. Twitter * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Twitter account */ /** * @typedef PinterestLink * @property {string} [title] - Name of the social media platform, e.g. Pinterest * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Pinterest page */ /** * @typedef GooglePlusLink * @property {string} [title] - Name of the social media platform, e.g. Google+ * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Google+ account */ /** * @typedef YoutubeLink * @property {string} [title] - Name of the social media platform, e.g. YouTube * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's YouTube channel */ /** * @typedef LinkedInLink * @property {string} [title] - Name of the social media platform, e.g. LinkedIn * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's LinkedIn channel */ /** * @typedef VimeoLink * @property {string} [title] - Name of the video hosting platform, e.g. Vimeo * @property {string} [icon] - Hosted URL of social icon image shown on the website * @property {string} [link] - Web URL of brand's Vimeo channel */ /** * @typedef BlogLink * @property {string} [title] - Name of the brand's blog page * @property {string} [icon] - Hosted URL of icon image shown on the website * @property {string} [link] - Web URL of brand's blog page */ /** * @typedef Links * @property {string} [title] - Name of the related page or link * @property {string} [link] - Web URL for redirecting to a related page */ /** * @typedef BusinessHighlights * @property {string} [_id] - Unique identifier of the related business * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery * @property {string} [icon] - Hosted URL of icon image representing the * business highlight * @property {string} [sub_title] - Detailed information about the highlight */ /** * @typedef ApplicationDetail * @property {string} name - Name of the sales channel. It is required. * @property {string} [description] - It gives a detailed information about the * sales channel. It is required. * @property {SecureUrl} [logo] * @property {SecureUrl} [mobile_logo] * @property {SecureUrl} [favicon] * @property {SecureUrl} [banner] * @property {Domain} [domain] * @property {Domain[]} [domains] * @property {string} [_id] - The unique identifier for the sales channel details * @property {string} [slug] * @property {number} [company_id] */ /** * @typedef CurrenciesResponseSchema * @property {Currency[]} [items] */ /** * @typedef AppCurrencyResponseSchema * @property {string} [_id] - The unique identifier of the currency * configuration supported by the application * @property {string} [application] - Alphanumeric ID allotted to an application * (sales channel website) created within a business account * @property {DefaultCurrency} [default_currency] * @property {Currency[]} [supported_currency] * @property {string} [created_at] - ISO 8601 timestamp when currency was added * in the list of currencies supported by the sales channel * @property {string} [modified_at] - ISO 8601 timestamp when currency was * updated in the list of currencies supported by the sales channel */ /** * @typedef StoreLatLong * @property {string} [type] - Coordinates type of the opted store * @property {number[]} [coordinates] */ /** * @typedef OptedStoreAddress * @property {string} [state] - State of the opted store, e.g. Maharashtra * @property {string} [address1] - Address of the opted store * @property {StoreLatLong} [lat_long] * @property {string} [address2] - Address of the opted store * @property {string} [pincode] - 6-digit PIN code of the opted store location * @property {string} [country] - Country of the opted store, e.g. India * @property {string} [city] - City of the opted store, e.g. Mumbai * @property {string} [sector] - Sector for the opted store. * @property {string} [country_code] - Country code of the selected country * @property {string} [state_code] - Selected state code */ /** * @typedef OrderingStore * @property {OptedStoreAddress} [address] * @property {string} [_id] - The unique identifier of the ordering store * @property {number} [uid] - Ordering store UID * @property {string} [name] - Store name of the ordering store * @property {string} [display_name] - Display name of the ordering store * @property {string} [store_type] - Store type of the ordering store, e.g. * high_street, mall, warehouse * @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102 * @property {string} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001 * @property {string} [code] - Code of the ordering store (usually same as Store Code) */ /** * @typedef OrderingStores * @property {Page} [page] * @property {OrderingStore[]} [items] * @property {number[]} [deployed_stores] * @property {boolean} [all_stores] - Allow all stores of the ordering stores * @property {boolean} [enabled] - Allow ordering stores for current sales channel * @property {string} [type] - For hard type delivery, store selection is * compulsory. For soft type, delivery store selection is optional. * @property {string} [_id] - The unique identifier of the ordering store * @property {string} [app] - Alphanumeric ID allotted to an application (sales * channel website) created within a business account * @property {number} [__v] - Version key for tracking ordering stores. Default * value is zero. */ /** * @typedef OrderingStoresResponseSchema * @property {Page} [page] * @property {OrderingStore[]} [items] */ /** * @typedef ValidationErrors * @property {ValidationError[]} errors - A list of validation errors in the request. */ /** * @typedef ValidationError * @property {string} message - A brief description of the error encountered. * @property {string} field - The field in the request that caused the error. */ declare class ConfigurationPlatformModel { } declare namespace ConfigurationPlatformModel { export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, ChannelCapabilities, OrderingSources, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, SecurityFeature, AllowedDomain, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError }; } /** @returns {CurrencyExchangeResponseV2} */ declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2; type CurrencyExchangeResponseV2 = { /** * - The 3-letter ISO 4217 code representing the base currency. */ base: string; /** * - The name of the base currency. */ base_currency_name: string; /** * - Time in seconds for which the exchange rates * are valid. */ ttl_seconds: number; /** * - List of exchange rates and currency details. */ items: CurrencyExchangeItem[]; /** * - Total number of currency exchange items. */ total: number; }; /** @returns {CurrencyExchangeItem} */ declare function CurrencyExchangeItem(): CurrencyExchangeItem; type CurrencyExchangeItem = { /** * - 3-letter ISO 4217 exchange currency code. */ currency_code: string; /** * - Name of the exchange currency */ name: string; /** * - Exchange rate of the currency with respect to the * base currency. */ rate: number; /** * - ISO 3166 country code. */ country_code: string; /** * - Name of the country using this currency. */ country_name: string; /** * - The name of the subunit for the currency. */ subunit: string; /** * - Number of decimal digits the currency supports. */ decimal_digits: number; /** * - The symbol of the currency. */ symbol: string; }; /** @returns {ApplicationInventory} */ declare function ApplicationInventory(): ApplicationInventory; type ApplicationInventory = { search?: SearchConfig; inventory?: AppInventoryConfig; authentication?: AuthenticationConfig; article_assignment?: ArticleAssignmentConfig; reward_points?: RewardPointsConfig; cart?: AppCartConfig; payment?: AppPaymentConfig; order?: AppOrderConfig; logistics?: AppLogisticsConfig; pii_masking?: PiiMasking; channel_capabilities?: ChannelCapabilities; tags?: string[]; __v?: number; /** * - Indicates the business type for sales channel * e.g. retail or wholesale */ business?: string; /** * - Shows communication(comms) is enabled * or not for sales channel inventory */ comms_enabled?: boolean; communication?: CommunicationConfig; platforms?: string[]; /** * - The unique identifier of the sales channel inventory */ _id?: string; loyalty_points?: LoyaltyPointsConfig; /** * - Current sales channel ID */ app?: string; /** * - ISO 8601 timestamp of sales channel * inventory creation */ created_at?: string; /** * - ISO 8601 timestamp of sales channel * inventory updation */ modified_at?: string; /** * - User ID of the person who made the latest * changes in the sales channel inventory */ modified_by?: string; }; /** @returns {PiiMasking} */ declare function PiiMasking(): PiiMasking; type PiiMasking = { enabled?: boolean; }; /** @returns {ChannelCapabilities} */ declare function ChannelCapabilities(): ChannelCapabilities; type ChannelCapabilities = { /** * - Commerce model types supported by the * sales channel. Defines whether the channel operates as B2C/D2C * (business-to-consumer/direct-to-consumer) or B2B (business-to-business). */ commerce_model: string[]; /** * - Business format types for the sales * channel. Options include standard_commerce for traditional e-commerce, * quick_commerce for rapid delivery models, and qsr for quick service * restaurant operations. */ business_format: string[]; /** * - Represents an ordering * source that can be associated with a sales channel. Ordering sources define * the origin or platform from which orders are placed, enabling tracking and * differentiation of orders based on their source. */ ordering_sources: OrderingSources[]; /** * - Seller model for the sales channel. * single_seller for single seller, marketplace for multiple platforms, * cross_selling for franchise-enabled. */ seller_model?: string; }; /** @returns {OrderingSources} */ declare function OrderingSources(): OrderingSources; type OrderingSources = { /** * - Unique identifier slug for the ordering source. Used * to reference and identify the source programmatically. */ key: string; /** * - Human-readable display name of the ordering source. * Shown in UI for easy identification by users. */ name: string; }; /** @returns {FstIdentification} */ declare function FstIdentification(): FstIdentification; type FstIdentification = { /** * - Indicates whether search query interpretation * is enabled for the application. */ enabled?: boolean; }; /** @returns {SkgIdentification} */ declare function SkgIdentification(): SkgIdentification; type SkgIdentification = { /** * - Indicates whether semantic knowledge * graph-based search is enabled for the application. */ enabled?: boolean; }; /** @returns {QuerySuggestions} */ declare function QuerySuggestions(): QuerySuggestions; type QuerySuggestions = { /** * - Indicates whether to enable or disable query * suggestions powered by the GPT model using the current live catalog within * the application. */ enabled?: boolean; /** * - Specifies the maximum number of query * suggestions that can be returned. */ max_limit?: number; }; /** @returns {SearchConfig} */ declare function SearchConfig(): SearchConfig; type SearchConfig = { fst_identification?: FstIdentification; query_suggestions?: QuerySuggestions; skg_identification?: SkgIdentification; }; /** @returns {AppInventoryConfig} */ declare function AppInventoryConfig(): AppInventoryConfig; type AppInventoryConfig = { delivery_strategy?: DeliveryStrategy; brand?: InventoryBrand; store?: InventoryStore; category?: InventoryCategory; price?: InventoryPrice; discount?: InventoryDiscount; /** * - Indicates whether price strategy * enabled or not in an application. */ price_strategy?: string; /** * - Indicates whether internation price * factory enabled or not in an application. */ international?: boolean; /** * - Indicates whether price * strategy change is pending or not in an application. */ strategy_change_pending?: boolean; /** * - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration */ strategy_modified_at?: string; /** * - Indicates whether out of stock products * are allowed to show up on the website */ out_of_stock?: boolean; /** * - Show only verified products * (the ones whose data has been verified by the admin) */ only_verified_products?: boolean; /** * - Allow other businesses (companies) * to consume the current sales channel's inventory and sell products */ franchise_enabled?: boolean; /** * - List of excluded brands category */ exclude_category?: any[]; image?: string[]; /** * - List of selling locations whose * inventory is available to the sales channel for displaying on the website */ company_store?: any[]; company_id?: number; }; /** @returns {InventoryBrand} */ declare function InventoryBrand(): InventoryBrand; type InventoryBrand = { /** * - All brands or specific (explicit) brands to * be shown on the website */ criteria?: string; /** * - List of brands */ brands?: number[]; }; /** @returns {InventoryStore} */ declare function InventoryStore(): InventoryStore; type InventoryStore = { /** * - All stores or specific (explicit) stores to * be shown on the website */ criteria?: string; /** * - List of stores */ stores?: any[]; /** * - Rules to show which brands or companies * products should be listed on sales channel. */ rules?: AppStoreRules[]; }; /** @returns {AppStoreRules} */ declare function AppStoreRules(): AppStoreRules; type AppStoreRules = { /** * - List of companies whose inventory is * available to the sales channel for displaying on the website */ companies?: number[]; /** * - List of brands whose products will be shown * on the website */ brands?: number[]; }; /** @returns {InventoryCategory} */ declare function InventoryCategory(): InventoryCategory; type InventoryCategory = { criteria?: string; /** * - List of categories whose products will be * shown on the website */ categories?: any[]; }; /** @returns {InventoryPrice} */ declare function InventoryPrice(): InventoryPrice; type InventoryPrice = { /** * - Minimum inventory price */ min?: number; /** * - Maximum inventory price */ max?: number; }; /** @returns {InventoryDiscount} */ declare function InventoryDiscount(): InventoryDiscount; type InventoryDiscount = { /** * - Minimum inventory discount */ min?: number; /** * - Maximum inventory discount */ max?: number; }; /** @returns {AuthenticationConfig} */ declare function AuthenticationConfig(): AuthenticationConfig; type AuthenticationConfig = { /** * - Shows sales channel inventory authentication * is required or not */ required?: boolean; /** * - Shows inventory authentication provider */ provider?: string; }; /** @returns {ArticleAssignmentConfig} */ declare function ArticleAssignmentConfig(): ArticleAssignmentConfig; type ArticleAssignmentConfig = { rules?: ArticleAssignmentRules; /** * - Allow post order reassigment of article */ post_order_reassignment?: boolean; enforced_stores?: number[]; }; /** @returns {ArticleAssignmentRules} */ declare function ArticleAssignmentRules(): ArticleAssignmentRules; type ArticleAssignmentRules = { store_priority?: StorePriority; }; /** @returns {StorePriority} */ declare function StorePriority(): StorePriority; type StorePriority = { /** * - Shows store priority is enabled or disabled * for assignment of article */ enabled?: boolean; /** * - List of store types for article * assignment e.g. warehouse, mall, highstreet */ storetype_order?: any[]; }; /** @returns {AppCartConfig} */ declare function AppCartConfig(): AppCartConfig; type AppCartConfig = { delivery_charges?: DeliveryCharges; international_delivery_charges?: InternationalDeliveryCharges; /** * - Shows whether cart configuration is enabled or not */ enabled?: boolean; /** * - Maximum number of items that can be * added to cart by the customer */ max_cart_items?: number; /** * - Minimum cart value below which customer * cannot place an order */ min_cart_value?: number; /** * - Allow creation of bulk coupons */ bulk_coupons?: boolean; /** * - Allow coupon apply and credits * together. Default value is false. */ revenue_engine_coupon?: boolean; pan_card?: PanCardConfig; /** * - If this is enabled, user can earn and * redeem loyalty points for the sales channel. */ engage_enabled?: boolean; /** * - If this is enabled, user can apply * coupons and promotions for the sales channel. */ offer_enabled?: boolean; }; /** @returns {InternationalDeliveryCharges} */ declare function InternationalDeliveryCharges(): InternationalDeliveryCharges; type InternationalDeliveryCharges = { /** * - Allow international delivery charges */ enabled?: boolean; charges?: Charges[]; }; /** @returns {DeliveryCharges} */ declare function DeliveryCharges(): DeliveryCharges; type DeliveryCharges = { /** * - Allow delivery charges */ enabled?: boolean; /** * - Holds values for delivery charges. */ charges?: Charges[]; }; /** @returns {Charges} */ declare function Charges(): Charges; type Charges = { /** * - The order value below which an extra * delivery fee will be applicable */ threshold?: number; /** * - Delivery amount to be charged when order value * is below the defined threshold value */ charges?: number; }; /** @returns {AppPaymentConfig} */ declare function AppPaymentConfig(): AppPaymentConfig; type AppPaymentConfig = { callback_url?: CallbackUrl; methods?: Methods; payment_selection_lock?: PaymentSelectionLock; /** * - Mode of payment for sales channel * payment, e.g. 'ECOMM'. */ mode_of_payment?: string; /** * - Source of the payment mode, e.g. 'ECOMM'. * Default value is FYND. */ source?: string; /** * - Allow payment option within sales channel */ enabled?: boolean; /** * - Maximum amount allowed for COD order. * Beyond this, customer cannot opt for COD. */ cod_amount_limit?: number; /** * - Extra charge applicable for COD orders */ cod_charges?: number; /** * - Allow cash on delivery for anonymous user */ anonymous_cod?: boolean; user_cod_limit?: number; }; /** @returns {CallbackUrl} */ declare function CallbackUrl(): CallbackUrl; type CallbackUrl = { /** * - Payment callback url for app */ app?: string; /** * - Payment callback url for web */ web?: string; }; /** @returns {Methods} */ declare function Methods(): Methods; type Methods = { pl?: PaymentModeConfig; card?: PaymentModeConfig; nb?: PaymentModeConfig; wl?: PaymentModeConfig; ps?: PaymentModeConfig; upi?: PaymentModeConfig; qr?: PaymentModeConfig; cod?: PaymentModeConfig; pp?: PaymentModeConfig; jp?: PaymentModeConfig; pac?: PaymentModeConfig; fc?: PaymentModeConfig; jiopp?: PaymentModeConfig; stripepg?: PaymentModeConfig; juspaypg?: PaymentModeConfig; payubizpg?: PaymentModeConfig; payumoneypg?: PaymentModeConfig; rupifipg?: PaymentModeConfig; simpl?: PaymentModeConfig; }; /** @returns {PaymentModeConfig} */ declare function PaymentModeConfig(): PaymentModeConfig; type PaymentModeConfig = { /** * - Shows if a given payment method is enabled or * not, e.g. if 'nb' is enabled, customer can use NetBanking for payment. */ enabled?: boolean; }; /** @returns {PaymentSelectionLock} */ declare function PaymentSelectionLock(): PaymentSelectionLock; type PaymentSelectionLock = { /** * - Shows whether payment mode is restricted to a * specific option, e.g. 'HDFC Netbanking' */ enabled?: boolean; /** * - Shows default payment method, e.g. COD */ default_options?: string; /** * - Payment method chosen from default * options, e.g. COD */ payment_identifier?: string; }; /** @returns {AppOrderConfig} */ declare function AppOrderConfig(): AppOrderConfig; type AppOrderConfig = { /** * - Allow orders to be accepted from the sales channel */ enabled?: boolean; /** * - Allow force reassigning of an order */ force_reassignment?: boolean; /** * - Reason for reassigning an order */ message?: string; processing_schedule?: ProcessingSchedule; }; /** @returns {ProcessingSchedule} */ declare function ProcessingSchedule(): ProcessingSchedule; type ProcessingSchedule = { /** * - Indicates whether the order processing * is scheduled for future. */ is_scheduled?: boolean; start_after?: StartAfter; }; /** @returns {StartAfter} */ declare function StartAfter(): StartAfter; type StartAfter = { /** * - Number of days to wait before starting the process. */ days?: number; /** * - Number of hours to wait before starting the process. */ hours?: number; /** * - Number of minutes to wait before starting the process. */ minutes?: number; }; /** @returns {AppLogisticsConfig} */ declare function AppLogisticsConfig(): AppLogisticsConfig; type AppLogisticsConfig = { logistics_by_seller?: boolean; serviceability_check?: boolean; same_day_delivery?: boolean; dp_assignment?: boolean; }; /** @returns {LoyaltyPointsConfig} */ declare function LoyaltyPointsConfig(): LoyaltyPointsConfig; type LoyaltyPointsConfig = { /** * - Shows loyalty points is enabled or not enabled */ enabled?: boolean; /** * - Allow auto apply of loyalty points */ auto_apply?: boolean; }; /** @returns {AppInventoryPartialUpdate} */ declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate; type AppInventoryPartialUpdate = { search?: SearchConfig; reward_points?: RewardPointsConfig; cart?: AppCartConfig; payment?: AppPaymentConfig; loyalty_points?: LoyaltyPointsConfig; /** * - Shows communication (comms) is enabled * or not for sales channel partial inventory update */ comms_enabled?: boolean; communication?: CommunicationConfig; }; /** @returns {BrandCompanyInfo} */ declare function BrandCompanyInfo(): BrandCompanyInfo; type BrandCompanyInfo = { /** * - Name of the company dealing with the brand */ company_name?: string; /** * - Numeric ID allotted to a business account */ company_id?: number; }; /** @returns {CompanyByBrandsRequestSchema} */ declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema; type CompanyByBrandsRequestSchema = { /** * - Brand UID */ brands: number; /** * - A search field for finding a company by its name */ search_text?: string; }; /** @returns {CompanyByBrandsResponseSchema} */ declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema; type CompanyByBrandsResponseSchema = { items?: BrandCompanyInfo[]; page?: Page; }; /** @returns {StoreByBrandsRequestSchema} */ declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema; type StoreByBrandsRequestSchema = { /** * - Current company ID for current company * stores only. Don't send in case cross-selling (franchise) is enabled. */ company_id?: number; /** * - Brand UID */ brands: number; /** * - Search store by its name or store code */ search_text?: string; }; /** @returns {StoreByBrandsResponseSchema} */ declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema; type StoreByBrandsResponseSchema = { items?: BrandStoreInfo[]; page?: Page; }; /** @returns {BrandStoreInfo} */ declare function BrandStoreInfo(): BrandStoreInfo; type BrandStoreInfo = { /** * - Name of the selling location (store) */ store_name?: string; /** * - The unique identifier of the selling location (store) */ store_id?: number; /** * - Store type of the brand like warehouse, * high_street, mall */ store_type?: string; /** * - Store code of the brand. It is unique for * every brand store. */ store_code?: string; store_address?: OptedStoreAddress; company?: OptedCompany; }; /** @returns {CompanyBrandInfo} */ declare function CompanyBrandInfo(): CompanyBrandInfo; type CompanyBrandInfo = { /** * - Brand name, e.g. Raymonds */ name?: string; /** * - Brand UID for identifying the brand */ value?: number; /** * - Hosted URL of the brand's logo */ brand_logo_url?: string; /** * - Hosted URL of the brand's banner image */ brand_banner_url?: string; /** * - Hosted URL of the brand's * portrait banner */ brand_banner_portrait_url?: string; }; /** @returns {BrandsByCompanyResponseSchema} */ declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema; type BrandsByCompanyResponseSchema = { brands?: CompanyBrandInfo[]; }; /** @returns {ValidationFailedResponseSchema} */ declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema; type ValidationFailedResponseSchema = { /** * - Response message for failed validation */ message?: string; }; /** @returns {NotFound} */ declare function NotFound(): NotFound; type NotFound = { /** * - Response message for not found */ message?: string; /** * - Flag for required not successfull. */ success?: boolean; }; /** @returns {CommunicationConfig} */ declare function CommunicationConfig(): CommunicationConfig; type CommunicationConfig = { email?: CommsConfig; sms?: CommsConfig; voice?: CommsConfig; }; /** @returns {CommsConfig} */ declare function CommsConfig(): CommsConfig; type CommsConfig = { /** * - Check current communication channel is enabled */ enabled?: boolean; }; /** @returns {PanCardConfig} */ declare function PanCardConfig(): PanCardConfig; type PanCardConfig = { /** * - If pan card accepting is enabled on cart */ enabled?: boolean; /** * - On which COD order amount pan * card number is expected from customer for order */ cod_threshold_amount?: number; /** * - On which online payment order * amount pan card number is expected from customer for order */ online_threshold_amount?: number; }; /** @returns {CreateApplicationRequestSchema} */ declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema; type CreateApplicationRequestSchema = { app?: App; configuration?: ApplicationInventory; domain?: AppDomain; }; /** @returns {CreateAppResponseSchema} */ declare function CreateAppResponseSchema(): CreateAppResponseSchema; type CreateAppResponseSchema = { app?: Application; configuration?: ApplicationInventory; }; /** @returns {ApplicationsResponseSchema} */ declare function ApplicationsResponseSchema(): ApplicationsResponseSchema; type ApplicationsResponseSchema = { items?: Application[]; page?: Page; }; /** @returns {MobileAppConfiguration} */ declare function MobileAppConfiguration(): MobileAppConfiguration; type MobileAppConfiguration = { /** * - Indicates the availability of the mobile build */ is_active?: boolean; /** * - The unique identifier for mobile application configuration */ _id?: string; /** * - Name of the mobile app */ app_name?: string; landing_image?: LandingImage; splash_image?: SplashImage; /** * - Application ID of the current sales channel */ application?: string; /** * - Device platform for which the mobile app * was built, e.g. android, ios. */ platform_type?: string; /** * - ISO 8601 timestamp of application * configuration creation */ created_at?: string; /** * - ISO 8601 timestamp of last known * modifications to the app build */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; /** * - Shows bundle identifier if device * platform is iOS, and directory of the app if device platform is Android */ package_name?: string; }; /** @returns {LandingImage} */ declare function LandingImage(): LandingImage; type LandingImage = { /** * - Width-to-height ratio of landing image */ aspect_ratio?: string; /** * - URL where the landing image is hosted */ secure_url?: string; }; /** @returns {SplashImage} */ declare function SplashImage(): SplashImage; type SplashImage = { /** * - Width-to-height ratio of splash image */ aspect_ratio?: string; /** * - URL where the splash image is hosted */ secure_url?: string; }; /** @returns {MobileAppConfigRequestSchema} */ declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema; type MobileAppConfigRequestSchema = { /** * - Name of the mobile app */ app_name?: string; landing_image?: LandingImage; splash_image?: SplashImage; /** * - Shows update in mobile app config is active or not */ is_active?: boolean; }; /** @returns {BuildVersionHistory} */ declare function BuildVersionHistory(): BuildVersionHistory; type BuildVersionHistory = { versions?: BuildVersion[]; /** * - Latest version number of * the mobile build, in dot-decimal notation */ latest_available_version_name?: string; }; /** @returns {BuildVersion} */ declare function BuildVersion(): BuildVersion; type BuildVersion = { /** * - Primary Identifier of the build version. */ _id?: string; /** * - Application ID of the sales channel */ application?: string; /** * - Device platform for which the mobile app * was built, e.g. android, ios. */ platform_type?: string; /** * - Current progress of the mobile build, * e.g. pending, cancelled, failed, success */ build_status?: string; /** * - Version number of the mobile build, in * dot-decimal notation */ version_name?: string; /** * - A positive integer used as an internal * version number */ version_code?: number; download_url?: LandingImage; /** * - ISO 8601 timestamp of app creation */ created_at?: string; /** * - ISO 8601 timestamp of last known * modifications to the app build */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; }; /** @returns {AppSupportedCurrency} */ declare function AppSupportedCurrency(): AppSupportedCurrency; type AppSupportedCurrency = { /** * - The unique identifier of the currency * configuration supported by the application */ _id?: string; supported_currency?: string[]; /** * - Alphanumeric ID allotted to an application * (sales channel website) created within a business account. */ application?: string; default_currency?: DefaultCurrency; /** * - ISO 8601 timestamp when currency was added * in the list of currencies supported by the sales channel */ created_at?: string; /** * - ISO 8601 timestamp when currency was * updated in the list of currencies supported by the sales channel */ modified_at?: string; }; /** @returns {DefaultCurrency} */ declare function DefaultCurrency(): DefaultCurrency; type DefaultCurrency = { /** * - The unique identifier of the default currency */ ref?: string; /** * - 3-character code of the default currency, e.g. * INR, EUR, USD */ code?: string; }; /** @returns {DomainAdd} */ declare function DomainAdd(): DomainAdd; type DomainAdd = { /** * - Full domain name, e.g. uniket.hostx0.de */ name?: string; /** * - The unique identifier of the domain */ _id?: string; /** * - Domain is verified or not (indicates if A * records and TXT records are correct) */ verified?: boolean; /** * - Domain is primary or not (indicates if the * domain has been made the main URL of the sales channel) */ is_primary?: boolean; /** * - Indicates if the domain is a short link * domain (short URL e.g. bitly) */ is_shortlink?: boolean; /** * - Shows the message shown after adding a domain * successfully, e.g. 'New domain added successfully' */ message?: string; txt_records?: string[]; }; /** @returns {DomainAddRequestSchema} */ declare function DomainAddRequestSchema(): DomainAddRequestSchema; type DomainAddRequestSchema = { domain?: DomainAdd; }; /** @returns {Domain} */ declare function Domain(): Domain; type Domain = { /** * - Full domain name, e.g. newton.com */ name?: string; /** * - The unique identifier of the sales channel domain */ _id?: string; /** * - Domain is verified or not. TXT and A records * should propagate correctly. */ verified?: boolean; /** * - Domain is primary or not. Primary domain * is the default/main domain. */ is_primary?: boolean; /** * - Shortlink is present or not for the domain */ is_shortlink?: boolean; /** * - Domain is hosting domain or not. */ is_predefined?: boolean; message?: string; }; /** @returns {DomainsResponseSchema} */ declare function DomainsResponseSchema(): DomainsResponseSchema; type DomainsResponseSchema = { domains?: Domain[]; }; /** @returns {UpdateDomain} */ declare function UpdateDomain(): UpdateDomain; type UpdateDomain = { /** * - Full domain name, e.g. zenz.com */ name?: string; /** * - The unique identifier of the domain */ _id?: string; /** * - Domain is verified or not (indicates if A * records and TXT records are correct) */ verified?: boolean; /** * - Domain is primary or not (indicates if the * domain has been made the main URL of the sales channel) */ is_primary?: boolean; /** * - Indicates if the domain is a short link * domain (short URL e.g. bit.ly) */ is_shortlink?: boolean; }; /** @returns {UpdateDomainTypeRequestSchema} */ declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema; type UpdateDomainTypeRequestSchema = { domain?: UpdateDomain; /** * - Shows domain is made primary domain for the * sales channel or shorlink is created for the sales channel domain */ action?: string; }; /** @returns {DomainStatusRequestSchema} */ declare function DomainStatusRequestSchema(): DomainStatusRequestSchema; type DomainStatusRequestSchema = { /** * - URL of the domain, e.g. uniket.hostx0.de */ domain_url?: string; }; /** @returns {DomainStatus} */ declare function DomainStatus(): DomainStatus; type DomainStatus = { /** * - Shows TXT record and A records for the domain */ display?: string; /** * - Shows whether TXT record or A records for the * domain are correctly propagating via DNS servers */ status?: boolean; }; /** @returns {DomainStatusResponseSchema} */ declare function DomainStatusResponseSchema(): DomainStatusResponseSchema; type DomainStatusResponseSchema = { /** * - Check if domain is live and mapped to * appropriate IP of Fynd Servers */ connected?: boolean; status?: DomainStatus[]; }; /** @returns {DomainSuggestionsRequestSchema} */ declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema; type DomainSuggestionsRequestSchema = { /** * - Domain url */ domain_url?: string; /** * - Get suggestions for custom domains or * Fynd domains */ custom_domain?: boolean; }; /** @returns {DomainSuggestion} */ declare function DomainSuggestion(): DomainSuggestion; type DomainSuggestion = { /** * - URL of the custom domain */ name: string; /** * - Shows whether TLD domain is supported or not */ unsupported?: boolean; /** * - Shows whether the custom domain of your * choice is available or not available */ is_available: boolean; /** * - Cost of purchasing a custom domain. Not present * for Fynd domains. */ price?: number; /** * - Custom domain currency. Not present for Fynd domains. */ currency?: string; }; /** @returns {DomainSuggestionsResponseSchema} */ declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema; type DomainSuggestionsResponseSchema = { /** * - Domain URL */ domains?: DomainSuggestion[]; }; /** @returns {SuccessMessageResponseSchema} */ declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema; type SuccessMessageResponseSchema = { /** * - Shows whether domain was deleted successfully */ success?: boolean; /** * - Success message shown to the user (in a string format) */ message?: string; }; /** @returns {App} */ declare function App(): App; type App = { /** * - Numeric ID allotted to a business account * on Fynd Platform. */ company_id?: string; /** * - It indicates different channel types like * store, website-and-mobile-apps. Default value is store */ channel_type?: string; auth?: ApplicationAuth; /** * - User-friendly name for sales channel, e.g. Zenz Fashion */ name?: string; /** * - Detailed description about the sales channel */ desc?: string; }; /** @returns {AppDomain} */ declare function AppDomain(): AppDomain; type AppDomain = { /** * - Domain URL of current sales channel, e.g. zenz.com */ name?: string; }; /** @returns {CompaniesResponseSchema} */ declare function CompaniesResponseSchema(): CompaniesResponseSchema; type CompaniesResponseSchema = { items?: AppInventoryCompanies[]; page?: Page; }; /** @returns {AppInventoryCompanies} */ declare function AppInventoryCompanies(): AppInventoryCompanies; type AppInventoryCompanies = { /** * - UID of the company, e.g. 108 */ uid?: number; /** * - Name of the company, e.g. Newton Traders */ name?: string; /** * - Indicates the type of the company, e.g. * franchisee, distributor, etc. */ company_type?: string; }; /** @returns {StoresResponseSchema} */ declare function StoresResponseSchema(): StoresResponseSchema; type StoresResponseSchema = { items?: AppInventoryStores[]; page?: Page; }; /** @returns {AppInventoryStores} */ declare function AppInventoryStores(): AppInventoryStores; type AppInventoryStores = { /** * - The unique identifier of the store in the sales * channel inventory */ _id?: string; /** * - ISO 8601 timestamp of last known updation * to the stores in sales channel inventory */ modified_on?: string; /** * - Sales channel inventory store UID */ uid?: number; /** * - Name of the store in the sales channel inventory, * e.g. Reebok Mumbai */ name?: string; /** * - Display name of the sales channel * inventory store (can be different than the actual store name), e.g. Reebok MUM */ display_name?: string; /** * - Store type of the sales channel inventory * store, such as mall, warehouse, high_street */ store_type?: string; /** * - Store code of the enabled inventory store, * e.g. HS-c9bac. It is unique for every store. */ store_code?: string; /** * - Company ID of the selling location (store) * added to the sales channel's inventory */ company_id?: number; address?: any; integration_type?: any; }; /** @returns {FilterOrderingStoreRequestSchema} */ declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema; type FilterOrderingStoreRequestSchema = { /** * - Allow all stores from the ordering stores */ all_stores?: boolean; deployed_stores?: number[]; /** * - Store code or name of the ordering store */ q?: string; }; /** @returns {DeploymentMeta} */ declare function DeploymentMeta(): DeploymentMeta; type DeploymentMeta = { deployed_stores?: number[]; /** * - Allow all stores from the ordering store */ all_stores?: boolean; /** * - Allow ordering stores for current sales channel */ enabled?: boolean; /** * - Permitted values are 'hard' and 'soft'. For hard * type delivery, store selection is compulsory. For soft type, delivery store * selection is optional. */ type?: string; /** * - The unique identifier of the ordering stores */ _id?: string; /** * - Alphanumeric ID allotted to an application (sales * channel website) created within a business account */ app?: string; __v?: number; }; /** @returns {OrderingStoreConfig} */ declare function OrderingStoreConfig(): OrderingStoreConfig; type OrderingStoreConfig = { deployment_meta?: DeploymentMeta; }; /** @returns {OrderingStoreSelectRequestSchema} */ declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema; type OrderingStoreSelectRequestSchema = { ordering_store: OrderingStoreSelect; }; /** @returns {OrderingStoreSelect} */ declare function OrderingStoreSelect(): OrderingStoreSelect; type OrderingStoreSelect = { /** * - Ordering store unique uid. It is required. */ uid: number; }; /** @returns {OtherSellerCompany} */ declare function OtherSellerCompany(): OtherSellerCompany; type OtherSellerCompany = { /** * - Uid of the seller company */ uid?: number; /** * - Name of the seller company */ name?: string; }; /** @returns {OtherSellerApplication} */ declare function OtherSellerApplication(): OtherSellerApplication; type OtherSellerApplication = { /** * - Name of the other seller's sales channel */ name?: string; /** * - Basic details about the other seller's sales channel */ description?: string; /** * - The unique identifier of the other seller's sales channel */ _id?: string; /** * - Domain URL of the other seller's sales channel */ domain?: string; company?: OtherSellerCompany; /** * - Inventory opted by the other seller's sales * channel. It can be the current company or stores in the current company. */ opt_type?: string; }; /** @returns {OtherSellerApplications} */ declare function OtherSellerApplications(): OtherSellerApplications; type OtherSellerApplications = { items?: OtherSellerApplication[]; page?: Page; }; /** @returns {OptedApplicationResponseSchema} */ declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema; type OptedApplicationResponseSchema = { /** * - Name of the other seller's sales channel */ name?: string; /** * - Basic details about the other seller's sales channel */ description?: string; /** * - The unique identifier of the other seller's sales channel */ _id?: string; /** * - Domain URL of the other seller's sales channel */ domain?: string; company?: OptedCompany; opted_inventory?: OptedInventory; opt_out_inventory?: OptOutInventory; }; /** @returns {OptedCompany} */ declare function OptedCompany(): OptedCompany; type OptedCompany = { /** * - Company UID opted by the other seller's sales * channel in its inventory. It has unique value for the company. */ uid?: number; /** * - Name of the company opted by the other seller's * sales channel in its inventory */ name?: string; /** * - The unique identifier of the opted inventory company */ id?: number; }; /** @returns {OptedInventory} */ declare function OptedInventory(): OptedInventory; type OptedInventory = { opt_type?: OptType; items?: any[]; }; /** @returns {OptType} */ declare function OptType(): OptType; type OptType = { /** * - Opted type of inventory store. It can be store or company. */ key?: string; /** * - Display text of opted type for inventory store */ display?: string; }; /** @returns {OptedStore} */ declare function OptedStore(): OptedStore; type OptedStore = { /** * - Name of the inventory store opted by other * seller's application */ name?: string; /** * - Store code of the opted inventory store. It * is unique for every store. */ store_code?: string; /** * - The unique identifier of the opted inventory store */ _id?: string; /** * - ISO 8601 timestamp of opted inventory store creation */ modified_on?: string; /** * - UID of opted inventory store */ uid?: number; address?: OptedStoreAddress; /** * - Display name of the opted inventory store */ display_name?: string; /** * - Store type of the opted inventory store * like warehouse, high_street, mall. */ store_type?: string; /** * - Company ID of the opted inventory store */ company_id?: number; }; /** @returns {OptOutInventory} */ declare function OptOutInventory(): OptOutInventory; type OptOutInventory = { /** * - List of selling locations (stores) opted out * from the inventory of other seller's application */ store: number[]; /** * - List of companies opted out from the inventory * of other seller's application */ company: number[]; }; /** @returns {TokenResponseSchema} */ declare function TokenResponseSchema(): TokenResponseSchema; type TokenResponseSchema = { tokens?: Tokens; /** * - The unique identifier of the token */ _id?: string; /** * - Alphanumeric ID allotted to the current * application created within the current business account */ application?: string; /** * - ISO 8601 timestamp of token creation */ created_at?: string; /** * - ISO 8601 timestamp of token updation */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; }; /** @returns {Tokens} */ declare function Tokens(): Tokens; type Tokens = { firebase?: Firebase; moengage?: Moengage; segment?: Segment; gtm?: Gtm; freshchat?: Freshchat; safetynet?: Safetynet; fynd_rewards?: FyndRewards; google_map?: GoogleMap; }; /** @returns {Firebase} */ declare function Firebase(): Firebase; type Firebase = { credentials?: Credentials; /** * - Shows whether Firebase integration is enabled * or disabled for the sales channel */ enabled?: boolean; }; /** @returns {Credentials} */ declare function Credentials(): Credentials; type Credentials = { ios?: Ios; android?: Android; /** * - Project ID for Firebase integration. * Project ID is a unique identifier for a project and is used only within the console. */ project_id?: string; /** * - Google Cloud Manager's Sender ID for * Firebase. It is a unique numerical value which is created when you * configure your project in the Google Developers Console/Google Cloud Console. */ gcm_sender_id?: string; /** * - Alphanumeric ID allotted to the current * application created within the current business account */ application_id?: string; /** * - An API key is a unique string that's used to * route requests to your Firebase project when interacting with Firebase. */ api_key?: string; }; /** @returns {Ios} */ declare function Ios(): Ios; type Ios = { /** * - Alphanumeric ID allotted to a sales * channel application created within a business account */ application_id?: string; /** * - Firebase secret credential API key for IOS */ api_key?: string; }; /** @returns {Android} */ declare function Android(): Android; type Android = { /** * - Alphanumeric ID allotted to a sales * channel application created within a business account */ application_id?: string; /** * - Firebase secret credential API key for Android */ api_key?: string; }; /** @returns {Moengage} */ declare function Moengage(): Moengage; type Moengage = { credentials?: MoengageCredentials; /** * - Shows whether MoEngage integation is enabled * or disabled for the sales channel */ enabled?: boolean; }; /** @returns {MoengageCredentials} */ declare function MoengageCredentials(): MoengageCredentials; type MoengageCredentials = { /** * - APP ID provided by MoEngage to identify a * specific app. The app_id for your MoEngage account is available on the * MoEngage Dashboard. */ app_id?: string; }; /** @returns {Segment} */ declare function Segment(): Segment; type Segment = { credentials?: SegmentCredentials; /** * - Shows whether Segment integration is enabled * or disabled for the sales channel */ enabled?: boolean; }; /** @returns {SegmentCredentials} */ declare function SegmentCredentials(): SegmentCredentials; type SegmentCredentials = { /** * - The unique identifier for a source that * tells Segment from which source data is coming from, to which workspace the * data belongs, and which destinations should receive the data. */ write_key?: string; }; /** @returns {Gtm} */ declare function Gtm(): Gtm; type Gtm = { credentials?: GtmCredentials; /** * - Shows whether GTM integration is enabled or * disabled for the sales channel */ enabled?: boolean; }; /** @returns {GtmCredentials} */ declare function GtmCredentials(): GtmCredentials; type GtmCredentials = { /** * - Secret credential API key for GTM */ api_key?: string; }; /** @returns {Freshchat} */ declare function Freshchat(): Freshchat; type Freshchat = { credentials?: FreshchatCredentials; /** * - Shows whether Freshchat integration is * enabled or disabled for the sales channel */ enabled?: boolean; }; /** @returns {FreshchatCredentials} */ declare function FreshchatCredentials(): FreshchatCredentials; type FreshchatCredentials = { /** * - The unique app_id of your Freshchat account for * integrating Freshchat with your sales channel */ app_id?: string; /** * - The unique app_key of your Freshchat account * for integrating Freshchat with your sales channel */ app_key?: string; /** * - Web token used for accessing the Freshchat APIs */ web_token?: string; }; /** @returns {Safetynet} */ declare function Safetynet(): Safetynet; type Safetynet = { credentials?: SafetynetCredentials; /** * - Shows whether Safetynet integration is * enabled or disabled for the sales channel */ enabled?: boolean; }; /** @returns {SafetynetCredentials} */ declare function SafetynetCredentials(): SafetynetCredentials; type SafetynetCredentials = { /** * - Secret credential API key for Safetynet. This * API key is used for calling the methods of Safetynet APIs. */ api_key?: string; }; /** @returns {FyndRewards} */ declare function FyndRewards(): FyndRewards; type FyndRewards = { credentials?: FyndRewardsCredentials; }; /** @returns {FyndRewardsCredentials} */ declare function FyndRewardsCredentials(): FyndRewardsCredentials; type FyndRewardsCredentials = { /** * - Public key for integrating with Fynd rewards. */ public_key?: string; /** * - Public key for integrating with Fynd rewards. */ private_key?: string; }; /** @returns {GoogleMap} */ declare function GoogleMap(): GoogleMap; type GoogleMap = { /** * - Shows whether Google map integration is enabled or not. */ enabled?: boolean; credentials?: GoogleMapCredentials; }; /** @returns {GoogleMapCredentials} */ declare function GoogleMapCredentials(): GoogleMapCredentials; type GoogleMapCredentials = { /** * - Secret API key for Google Maps. A unique * identifier that authenticates requests made to Google Maps API. */ api_key?: string; }; /** @returns {RewardPointsConfig} */ declare function RewardPointsConfig(): RewardPointsConfig; type RewardPointsConfig = { credit?: Credit; debit?: Debit; }; /** @returns {Credit} */ declare function Credit(): Credit; type Credit = { /** * - Shows whether reward points should be credited */ enabled?: boolean; }; /** @returns {Debit} */ declare function Debit(): Debit; type Debit = { /** * - Shows whether reward points are available for debit */ enabled?: boolean; /** * - Allow automatic debit of reward points */ auto_apply?: boolean; /** * - Strategy channel for debiting reward points */ strategy_channel?: string; }; /** @returns {ProductDetailFeature} */ declare function ProductDetailFeature(): ProductDetailFeature; type ProductDetailFeature = { /** * - Configuration to show similar products, * other products from same seller, other products in same category, other * products in same price range, etc. */ similar?: string[]; /** * - Shows whether the customers can * choose the seller on PDP */ seller_selection?: boolean; /** * - Allow user to update product * meta. Default value is true. */ update_product_meta?: boolean; /** * - Indicates whether customers can * request for a product. Default value is false. */ request_product?: boolean; }; /** @returns {LaunchPage} */ declare function LaunchPage(): LaunchPage; type LaunchPage = { /** * - Type of the launch page */ page_type?: string; /** * - Launch page params. It can be nullable. */ params?: any; /** * - Query related to launch page. It can be nullable. */ query?: any; }; /** @returns {LandingPageFeature} */ declare function LandingPageFeature(): LandingPageFeature; type LandingPageFeature = { launch_page?: LaunchPage; /** * - Shows whether a guest can checkout * from cart without logging in */ continue_as_guest?: boolean; /** * - Shows the text displayed over the login button */ login_btn_text?: string; /** * - Shows whether a textbox for * entering domain is available */ show_domain_textbox?: boolean; /** * - Shows whether register button is * available in the login/landing page */ show_register_btn?: boolean; }; /** @returns {ListingPageFeature} */ declare function ListingPageFeature(): ListingPageFeature; type ListingPageFeature = { sort_on?: string; }; /** @returns {RegistrationPageFeature} */ declare function RegistrationPageFeature(): RegistrationPageFeature; type RegistrationPageFeature = { /** * - Shows whether a form to collect the * address of the store, should be displayed upon visiting the website */ ask_store_address?: boolean; }; /** @returns {BuyboxFeature} */ declare function BuyboxFeature(): BuyboxFeature; type BuyboxFeature = { /** * - Allow users to see seller/stores name on * PDP (product detail page). */ show_name?: boolean; /** * - Allow selection of sellers/stores on * PDP (product detail page). */ enable_selection?: boolean; /** * - Toggle buybox listing * between sellers and stores. True indicates seller listing, while False * indicates store listing. */ is_seller_buybox_enabled?: boolean; }; /** @returns {DeliveryStrategy} */ declare function DeliveryStrategy(): DeliveryStrategy; type DeliveryStrategy = { /** * - Indicates the delivery strategy value. */ value?: string; }; /** @returns {FulfillmentOption} */ declare function FulfillmentOption(): FulfillmentOption; type FulfillmentOption = { /** * - Total count of available fulfillment options * configured for a specific application. */ count?: number; }; /** @returns {AppFeature} */ declare function AppFeature(): AppFeature; type AppFeature = { product_detail?: ProductDetailFeature; landing_page?: LandingPageFeature; registration_page?: RegistrationPageFeature; home_page?: HomePageFeature; common?: CommonFeature; cart?: CartFeature; qr?: QrFeature; pcr?: PcrFeature; order?: OrderFeature; security?: SecurityFeature; buybox?: BuyboxFeature; delivery_strategy?: DeliveryStrategy; /** * - Represents an ordering * source that can be associated with a sales channel. Ordering sources define * the origin or platform from which orders are placed, enabling tracking and * differentiation of orders based on their source. */ ordering_sources?: OrderingSources[]; /** * - Indicates whether price strategy * enabled or not in an application. */ price_strategy?: string; /** * - Indicates whether internation price * factory enabled or not in an application. */ international?: boolean; /** * - Indicates whether price * strategy change is pending or not in an application. */ strategy_change_pending?: boolean; /** * - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration */ strategy_modified_at?: string; fulfillment_option?: FulfillmentOption; /** * - The unique identifier for the sales channel features */ _id?: string; /** * - Application ID of the sales channel */ app?: string; /** * - ISO 8601 timestamp showing the date when * the features were configured */ created_at?: string; /** * - ISO 8601 timestamp of last known * modifications to the sales channel feature configuration */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero */ __v?: number; }; /** @returns {HomePageFeature} */ declare function HomePageFeature(): HomePageFeature; type HomePageFeature = { /** * - Shows whether order processing is * enabled or not enabled */ order_processing?: boolean; }; /** @returns {CommonFeature} */ declare function CommonFeature(): CommonFeature; type CommonFeature = { communication_optin_dialog?: CommunicationOptinDialogFeature; deployment_store_selection?: DeploymentStoreSelectionFeature; listing_price?: ListingPriceFeature; listing_page?: ListingPageFeature; currency?: CurrencyFeature; revenue_engine?: RevenueEngineFeature; feedback?: FeedbackFeature; compare_products?: CompareProductsFeature; reward_points?: RewardPointsConfig; international_shipping?: InternationalShipping; }; /** @returns {InternationalShipping} */ declare function InternationalShipping(): InternationalShipping; type InternationalShipping = { /** * - International shipping is enabled or not. */ enabled?: boolean; }; /** @returns {CommunicationOptinDialogFeature} */ declare function CommunicationOptinDialogFeature(): CommunicationOptinDialogFeature; type CommunicationOptinDialogFeature = { /** * - Shows whether WhatsApp communication is enabled */ visibility?: boolean; }; /** @returns {DeploymentStoreSelectionFeature} */ declare function DeploymentStoreSelectionFeature(): DeploymentStoreSelectionFeature; type DeploymentStoreSelectionFeature = { /** * - Shows whether selection of store (for * deploying the application) is permitted */ enabled?: boolean; /** * - Permitted values are 'hard' and 'soft'. For hard * type delivery, store selection is compulsory. For soft type, delivery store * selection is optional. */ type?: string; }; /** @returns {ListingPriceFeature} */ declare function ListingPriceFeature(): ListingPriceFeature; type ListingPriceFeature = { /** * - Shows which price to display on PLP if one * product has multiple prices (for each size), valid values are 'min', 'max', * 'range'. Default value is range. */ value?: string; /** * - Sorting of listing price with min or max value. * Default value is min. */ sort?: string; }; /** @returns {CurrencyFeature} */ declare function CurrencyFeature(): CurrencyFeature; type CurrencyFeature = { /** * - 3-letter currency code */ value?: string[]; /** * - If 'explicit', currency formatting shows currency * code with price. For explicit or all currency selection. */ type?: string; /** * - 3-letter code of the default currency * used in the application. Default vaule is 'INR'. */ default_currency?: string; }; /** @returns {RevenueEngineFeature} */ declare function RevenueEngineFeature(): RevenueEngineFeature; type RevenueEngineFeature = { /** * - Enable revenue engine. Default value is false. */ enabled?: boolean; }; /** @returns {FeedbackFeature} */ declare function FeedbackFeature(): FeedbackFeature; type FeedbackFeature = { /** * - Shows whether customer feedback is enabled on * PDP. Default value is false. */ enabled?: boolean; }; /** @returns {CompareProductsFeature} */ declare function CompareProductsFeature(): CompareProductsFeature; type CompareProductsFeature = { /** * - Shows whether product comparison feature is * enabled on PDP */ enabled?: boolean; }; /** @returns {CartFeature} */ declare function CartFeature(): CartFeature; type CartFeature = { /** * - Shows whether customer is allowed to enter * GST on the cart page for claiming input credits */ gst_input?: boolean; /** * - Shows whether staff selection is * enabled on cart page */ staff_selection?: boolean; /** * - Shows whether the staff is * placing order on behalf of customer. Default value is true. */ placing_for_customer?: boolean; /** * - Allow adding of Google Maps. Default value is true. */ google_map?: boolean; /** * - Allow coupon apply and credits, * together. Default value is false. */ revenue_engine_coupon?: boolean; }; /** @returns {QrFeature} */ declare function QrFeature(): QrFeature; type QrFeature = { /** * - Shows whether sharing of mobile app via * QR code is allowed. Default value is false. */ application?: boolean; /** * - Shows whether sharing product via QR code is * allowed. Default value is false. */ products?: boolean; /** * - Shows whether sharing collection via QR * code is allowed. Default value is false. */ collections?: boolean; }; /** @returns {PcrFeature} */ declare function PcrFeature(): PcrFeature; type PcrFeature = { /** * - Allow staff selection. Default value is false. */ staff_selection?: boolean; }; /** @returns {OrderFeature} */ declare function OrderFeature(): OrderFeature; type OrderFeature = { /** * - Allow buy again option for order. Default * value is false. */ buy_again?: boolean; }; /** @returns {SecurityFeature} */ declare function SecurityFeature(): SecurityFeature; type SecurityFeature = { /** * - List of allowed domains for security * restrictions. */ domains?: AllowedDomain[]; }; /** @returns {AllowedDomain} */ declare function AllowedDomain(): AllowedDomain; type AllowedDomain = { /** * - The host URL for the allowed domain. */ host: string; /** * - The protocol/scheme to use for the domain. * Default is https. */ url_scheme?: string; }; /** @returns {AppFeatureRequestSchema} */ declare function AppFeatureRequestSchema(): AppFeatureRequestSchema; type AppFeatureRequestSchema = { feature?: AppFeature; }; /** @returns {AppFeatureResponseSchema} */ declare function AppFeatureResponseSchema(): AppFeatureResponseSchema; type AppFeatureResponseSchema = { feature?: AppFeature; }; /** @returns {Currency} */ declare function Currency(): Currency; type Currency = { /** * - The unique identifier of the current sales channel * supported currency */ _id?: string; /** * - Shows currency is enabled or not in current * sales channel */ is_active?: boolean; /** * - Name of the currency, e.g Indian Rupee */ name?: string; /** * - 3-character currency code, e.g. INR, USD, EUR. */ code?: string; /** * - ISO 8601 timestamp of sales channel support * currency creation */ created_at?: string; /** * - ISO 8601 timestamp of sales channel * support currency updation */ modified_at?: string; /** * - Acceptable decimal limits for a given * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid * value of a currency. */ decimal_digits?: number; /** * - Unique symbol for identifying the currency, e.g. ₹ */ symbol?: string; country_name?: string; country_code?: string; }; /** @returns {ApplicationWebsite} */ declare function ApplicationWebsite(): ApplicationWebsite; type ApplicationWebsite = { /** * - Shows whether sales channel website URL is * enabled or not */ enabled?: boolean; /** * - Base path for the current sales channel website */ basepath?: string; }; /** @returns {ApplicationCors} */ declare function ApplicationCors(): ApplicationCors; type ApplicationCors = { domains?: string[]; }; /** @returns {ApplicationAuth} */ declare function ApplicationAuth(): ApplicationAuth; type ApplicationAuth = { /** * - Shows sales channel auth is enabled or not enabled. */ enabled?: boolean; }; /** @returns {ApplicationRedirections} */ declare function ApplicationRedirections(): ApplicationRedirections; type ApplicationRedirections = { /** * - Old domain url of the sales channel */ redirect_from?: string; /** * - New domain URL of the sales channel. Users * will be automatically redirected from old domain to new domain. */ redirect_to?: string; /** * - It shows domain redirection type. Permanent * redirection is for long time period redirection, and temporary redirection * for a short time period. */ type?: string; }; /** @returns {ApplicationMeta} */ declare function ApplicationMeta(): ApplicationMeta; type ApplicationMeta = { /** * - Indicates to name of application meta */ name?: string; /** * - Value related to application meta name */ value?: string; }; /** @returns {SecureUrl} */ declare function SecureUrl(): SecureUrl; type SecureUrl = { /** * - Hosted URL of the image */ secure_url?: string; }; /** @returns {Application} */ declare function Application(): Application; type Application = { website?: ApplicationWebsite; cors?: ApplicationCors; auth?: ApplicationAuth; /** * - It contains detailed information about the * sales channel. */ description?: string; /** * - It indicates different channel types like * store, website-and-mobile-apps. Default value is store */ channel_type?: string; /** * - An integer value that specifies the number * of seconds until the key expires */ cache_ttl?: number; /** * - Indicates whether a sales channel is * internal or not */ is_internal?: boolean; /** * - Indicates sales channel is active or not active */ is_active?: boolean; /** * - The unique identifier of the sales channel */ _id?: string; /** * - Name of the sales channel, e.g. Zenz Fashion */ name?: string; /** * - The unique identifier of owner who owns the application */ owner?: string; /** * - Numeric ID allotted to a business account * where the sales channel exists */ company_id?: number; /** * - Random generated fix length string for sales * channel. It is required and auto-generated. */ token?: string; redirections?: ApplicationRedirections[]; meta?: ApplicationMeta[]; /** * - ISO 8601 timestamp of sales channel creation */ created_at?: string; /** * - ISO 8601 timestamp of sales channel updation */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; banner?: SecureUrl; logo?: SecureUrl; favicon?: SecureUrl; domains?: Domain[]; /** * - It shows application is live or in development mode. */ app_type?: string; mobile_logo?: SecureUrl; domain?: Domain; slug?: string; mode?: string; status?: string; tokens?: TokenSchema[]; secret?: string; }; /** @returns {ApplicationById} */ declare function ApplicationById(): ApplicationById; type ApplicationById = { website?: ApplicationWebsite; cors?: ApplicationCors; auth?: ApplicationAuth; /** * - It contains detailed information about the * sales channel. */ description?: string; /** * - It indicates different types of channels, * such as store, website, and mobile apps, with 'store' being the default value. */ channel_type?: string; /** * - An integer value that specifies the number * of seconds until the key expires */ cache_ttl?: number; /** * - Indicates whether a sales channel is * internal or not */ is_internal?: boolean; /** * - Indicates sales channel is active or not active */ is_active?: boolean; /** * - The unique identifier of the sales channel */ _id?: string; /** * - Name of the sales channel, e.g. Zenz Fashion */ name?: string; /** * - The unique identifier of owner who owns the application */ owner?: string; /** * - Numeric ID allotted to a business account * where the sales channel exists */ company_id?: number; /** * - Random generated fix length string for sales * channel. It is required and auto-generated. */ token?: string; redirections?: ApplicationRedirections[]; meta?: ApplicationMeta[]; /** * - ISO 8601 timestamp of sales channel creation */ created_at?: string; /** * - ISO 8601 timestamp of sales channel updation */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; banner?: SecureUrl; logo?: SecureUrl; favicon?: SecureUrl; domains?: Domain[]; /** * - It shows application is live or in development mode. */ app_type?: string; mobile_logo?: SecureUrl; domain?: Domain; slug?: string; mode?: string; status?: string; tokens?: TokenSchemaID[]; secret?: string; }; /** @returns {TokenSchemaID} */ declare function TokenSchemaID(): TokenSchemaID; type TokenSchemaID = { token?: string; created_by?: string; /** * - ISO 8601 timestamp of when token created */ created_at?: string; }; /** @returns {TokenSchema} */ declare function TokenSchema(): TokenSchema; type TokenSchema = { token?: string; created_by?: any; /** * - ISO 8601 timestamp of when token created */ created_at?: string; }; /** @returns {InvalidPayloadRequestSchema} */ declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema; type InvalidPayloadRequestSchema = { /** * - Error message when request body payload is improper */ message?: string; /** * - Flag for required not successfull. */ success?: boolean; }; /** @returns {Page} */ declare function Page(): Page; type Page = { /** * - The total number of all items across all pages. */ item_total?: number; /** * - The identifier for the next page. */ next_id?: string; /** * - Indicates whether there is a previous page. */ has_previous?: boolean; /** * - Indicates whether there is a next page. */ has_next?: boolean; /** * - The current page number. */ current?: number; /** * - The type of the page, can be 'cursor' or 'number'. */ type: string; /** * - The number of items per page. */ size?: number; /** * - The number of items per page. */ page_size?: number; }; /** @returns {ApplicationInformation} */ declare function ApplicationInformation(): ApplicationInformation; type ApplicationInformation = { address?: InformationAddress; support?: InformationSupport; social_links?: SocialLinks; links?: Links[]; /** * - Copyright statement usually seen at the * site's footer */ copyright_text?: string; /** * - Unique identifier of the application information */ _id?: string; business_highlights?: BusinessHighlights[]; /** * - Alphanumeric ID allotted to a sales * channel application created within a business account */ application?: string; /** * - ISO 8601 timestamp of creation of the * application information */ created_at?: string; /** * - ISO 8601 timestamp of updation of the * application information */ modified_at?: string; /** * - Version key for tracking revisions. Default value is zero. */ __v?: number; }; /** @returns {InformationAddress} */ declare function InformationAddress(): InformationAddress; type InformationAddress = { loc?: InformationLoc; /** * - Contact address of the sales channel */ address_line?: string[]; phone?: InformationPhone[]; /** * - Name of the city, e.g. Mumbai */ city?: string; /** * - Name of the country, e.g. India */ country?: string; /** * - 6-digit PIN Code of the city, e.g. 400001 */ pincode?: number; }; /** @returns {InformationPhone} */ declare function InformationPhone(): InformationPhone; type InformationPhone = { /** * - Country code for contact number, e.g. +91 (for India) */ code?: string; /** * - 10-digit mobile number */ number?: string; }; /** @returns {InformationLoc} */ declare function InformationLoc(): InformationLoc; type InformationLoc = { /** * - Country code for contact number, e.g. +91 (for India) */ type?: string; /** * - 10-digit mobile number */ coordinates?: number[]; }; /** @returns {InformationSupport} */ declare function InformationSupport(): InformationSupport; type InformationSupport = { phone?: InformationSupportPhone[]; email?: InformationSupportEmail[]; /** * - Working hours of support team, e.g. 9 AM to 9 PM */ timing?: string; }; /** @returns {InformationSupportPhone} */ declare function InformationSupportPhone(): InformationSupportPhone; type InformationSupportPhone = { /** * - Country code for contact number, e.g. +91 (for India) */ code?: string; /** * - 10-digit mobile number */ number?: string; key?: string; }; /** @returns {InformationSupportEmail} */ declare function InformationSupportEmail(): InformationSupportEmail; type InformationSupportEmail = { /** * - Value of email. */ value?: string; key?: string; }; /** @returns {SocialLinks} */ declare function SocialLinks(): SocialLinks; type SocialLinks = { facebook?: FacebookLink; instagram?: InstagramLink; twitter?: TwitterLink; pinterest?: PinterestLink; google_plus?: GooglePlusLink; youtube?: YoutubeLink; linked_in?: LinkedInLink; vimeo?: VimeoLink; blog_link?: BlogLink; }; /** @returns {FacebookLink} */ declare function FacebookLink(): FacebookLink; type FacebookLink = { /** * - Name of the social media platform, e.g. Facebook */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Facebook page */ link?: string; }; /** @returns {InstagramLink} */ declare function InstagramLink(): InstagramLink; type InstagramLink = { /** * - Name of the social media platform, e.g. Instagram */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Instagram page */ link?: string; }; /** @returns {TwitterLink} */ declare function TwitterLink(): TwitterLink; type TwitterLink = { /** * - Name of the social media platform, e.g. Twitter */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Twitter account */ link?: string; }; /** @returns {PinterestLink} */ declare function PinterestLink(): PinterestLink; type PinterestLink = { /** * - Name of the social media platform, e.g. Pinterest */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Pinterest page */ link?: string; }; /** @returns {GooglePlusLink} */ declare function GooglePlusLink(): GooglePlusLink; type GooglePlusLink = { /** * - Name of the social media platform, e.g. Google+ */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Google+ account */ link?: string; }; /** @returns {YoutubeLink} */ declare function YoutubeLink(): YoutubeLink; type YoutubeLink = { /** * - Name of the social media platform, e.g. YouTube */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's YouTube channel */ link?: string; }; /** @returns {LinkedInLink} */ declare function LinkedInLink(): LinkedInLink; type LinkedInLink = { /** * - Name of the social media platform, e.g. LinkedIn */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's LinkedIn channel */ link?: string; }; /** @returns {VimeoLink} */ declare function VimeoLink(): VimeoLink; type VimeoLink = { /** * - Name of the video hosting platform, e.g. Vimeo */ title?: string; /** * - Hosted URL of social icon image shown on the website */ icon?: string; /** * - Web URL of brand's Vimeo channel */ link?: string; }; /** @returns {BlogLink} */ declare function BlogLink(): BlogLink; type BlogLink = { /** * - Name of the brand's blog page */ title?: string; /** * - Hosted URL of icon image shown on the website */ icon?: string; /** * - Web URL of brand's blog page */ link?: string; }; /** @returns {Links} */ declare function Links(): Links; type Links = { /** * - Name of the related page or link */ title?: string; /** * - Web URL for redirecting to a related page */ link?: string; }; /** @returns {BusinessHighlights} */ declare function BusinessHighlights(): BusinessHighlights; type BusinessHighlights = { /** * - Unique identifier of the related business */ _id?: string; /** * - Title of the business highlight, e.g. Superfast Delivery */ title?: string; /** * - Hosted URL of icon image representing the * business highlight */ icon?: string; /** * - Detailed information about the highlight */ sub_title?: string; }; /** @returns {ApplicationDetail} */ declare function ApplicationDetail(): ApplicationDetail; type ApplicationDetail = { /** * - Name of the sales channel. It is required. */ name: string; /** * - It gives a detailed information about the * sales channel. It is required. */ description?: string; logo?: SecureUrl; mobile_logo?: SecureUrl; favicon?: SecureUrl; banner?: SecureUrl; domain?: Domain; domains?: Domain[]; /** * - The unique identifier for the sales channel details */ _id?: string; slug?: string; company_id?: number; }; /** @returns {CurrenciesResponseSchema} */ declare function CurrenciesResponseSchema(): CurrenciesResponseSchema; type CurrenciesResponseSchema = { items?: Currency[]; }; /** @returns {AppCurrencyResponseSchema} */ declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema; type AppCurrencyResponseSchema = { /** * - The unique identifier of the currency * configuration supported by the application */ _id?: string; /** * - Alphanumeric ID allotted to an application * (sales channel website) created within a business account */ application?: string; default_currency?: DefaultCurrency; supported_currency?: Currency[]; /** * - ISO 8601 timestamp when currency was added * in the list of currencies supported by the sales channel */ created_at?: string; /** * - ISO 8601 timestamp when currency was * updated in the list of currencies supported by the sales channel */ modified_at?: string; }; /** @returns {StoreLatLong} */ declare function StoreLatLong(): StoreLatLong; type StoreLatLong = { /** * - Coordinates type of the opted store */ type?: string; coordinates?: number[]; }; /** @returns {OptedStoreAddress} */ declare function OptedStoreAddress(): OptedStoreAddress; type OptedStoreAddress = { /** * - State of the opted store, e.g. Maharashtra */ state?: string; /** * - Address of the opted store */ address1?: string; lat_long?: StoreLatLong; /** * - Address of the opted store */ address2?: string; /** * - 6-digit PIN code of the opted store location */ pincode?: string; /** * - Country of the opted store, e.g. India */ country?: string; /** * - City of the opted store, e.g. Mumbai */ city?: string; /** * - Sector for the opted store. */ sector?: string; /** * - Country code of the selected country */ country_code?: string; /** * - Selected state code */ state_code?: string; }; /** @returns {OrderingStore} */ declare function OrderingStore(): OrderingStore; type OrderingStore = { address?: OptedStoreAddress; /** * - The unique identifier of the ordering store */ _id?: string; /** * - Ordering store UID */ uid?: number; /** * - Store name of the ordering store */ name?: string; /** * - Display name of the ordering store */ display_name?: string; /** * - Store type of the ordering store, e.g. * high_street, mall, warehouse */ store_type?: string; /** * - Store code of the ordering store, e.g. MUM-102 */ store_code?: string; /** * - 6-digit PIN Code of the ordering store, e.g. 400001 */ pincode?: string; /** * - Code of the ordering store (usually same as Store Code) */ code?: string; }; /** @returns {OrderingStores} */ declare function OrderingStores(): OrderingStores; type OrderingStores = { page?: Page; items?: OrderingStore[]; deployed_stores?: number[]; /** * - Allow all stores of the ordering stores */ all_stores?: boolean; /** * - Allow ordering stores for current sales channel */ enabled?: boolean; /** * - For hard type delivery, store selection is * compulsory. For soft type, delivery store selection is optional. */ type?: string; /** * - The unique identifier of the ordering store */ _id?: string; /** * - Alphanumeric ID allotted to an application (sales * channel website) created within a business account */ app?: string; /** * - Version key for tracking ordering stores. Default * value is zero. */ __v?: number; }; /** @returns {OrderingStoresResponseSchema} */ declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema; type OrderingStoresResponseSchema = { page?: Page; items?: OrderingStore[]; }; /** @returns {ValidationErrors} */ declare function ValidationErrors(): ValidationErrors; type ValidationErrors = { /** * - A list of validation errors in the request. */ errors: ValidationError[]; }; /** @returns {ValidationError} */ declare function ValidationError(): ValidationError; type ValidationError = { /** * - A brief description of the error encountered. */ message: string; /** * - The field in the request that caused the error. */ field: string; };