1. Developing Open Storefront Framework Applications for Commerce Experience
  2. Configure Tenant

Configure Tenant

Tenant configuration is a REST service available to manage business configuration for the storefront application.

  1. To view existing configuration:
    1. Request URL: <fabric-host>/admin/tenantConfigurations
    2. Operation: GET
    3. Authorization: OAUTH2.0

      Use bearer token generated from <FA-Host>/fscmRestApi/tokenrelay?scope=<Fabric-Host>

  2. To edit the configuration, get the response using GET call and update the required configuration and do a PUT operation to the same endpoint with the whole object as payload.
  3. Here are the business configurations available by default:
    Area Comments Object Configuration Key Configuration Value Default Value Comments
    salesCatalog catalogMenu browsingStartMenu Catalog or Category Category Controls from where the browse menu starts. Either from catalog or category in storefront header.
    salesCatalog catalogMenu relevantCatalogs A valid catalog name to browse the categories within that catalog Supremo%20Consumer%20 Catalog Controls where to look for categories.
    salesCatalog catalogMenu relevantCategoryL1 A valid category names separated by a comma Residential Controls which categories to display on UI header.
    salesCatalog catalogMenu relevantCategoryL2 A valid category names separated by a comma Accessory,Smart%20Phone,Mobile,Streaming%20Service,SIM,Internet%20Packages Controls which categories to display within previous L1 category.
    salesCatalog daas enableDaas true/false false Controls if address verification service can be enabled or not.
    salesCatalog accessoryConfig Color Color%20Palette Color%20Palette
    salesCatalog accessoryConfig Capacity Selection%20Button Selection%20Button
    salesCatalog accessoryConfig Size Selection%20Button Selection%20Button
    salesCatalog accessoryConfig Style Selection%20Button Selection%20Button
    salesCatalog search filters A valid category names separated by a comma Smart%20Phone,Internet%20Packages Controls the suggestions to be shown on the search page.
    salesCatalog homeWidgetCategoryMap carousel Category Name TV Promotion, Internet Promotion, Streaming Promotion, Mobile Promotion Controls what product categories are shown on the carousel widgets on the homepage.
    salesCatalog homeWidgetCategoryMap BestSeller Category Name Mustang 2011,Mustang 2011 Pro, Vola S10,Ty G8 ThinkQ Controls what product category is mapped to the best seller widget on the homepage.
    salesCatalog homeWidgetCategoryMap topPlans Category Name Recommendation Controls what product category is mapped to the top plans widget on the homepage.
    salesCatalog homeWidgetCategoryMap topBanner Category Name LimitedTime Controls what product category is mapped to the top banner widget on the homepage.
    salesCatalog homeWidgetCategoryMap MiddleAdBanner Category Name Bundle Promotion Controls what product category is mapped to the middle advertisement widget on the homepage.
    salesCatalog homeWidgetCategoryMap Promotion1 Category Name Device Promotion Controls what product category is mapped to the second promotion widget on the homepage.
    salesCatalog homeWidgetCategoryMap Promotion2 Category Name New Customer Promo Controls what product category is mapped to the second promotion widget on the homepage.
    salesCatalog homeWidgetImageMap carousel Image URL carousel-1,carousel-2,carousel-3,carousel-4 Controls what images are mapped to the carousel widgets on the homepage.
    salesCatalog homeWidgetImageMap topPromotionBanner Image URL promo-belt Controls what image is mapped to the top promotion banner widget on the homepage.
    salesCatalog homeWidgetImageMap MiddleAdBanner_Image Image URL home-promo Controls what image is mapped to the middle advertisement banner widget on the homepage.
    salesCatalog homeWidgetImageMap Promotion1_Image Image URL Device Promotion Controls what image is mapped to the first promotion banner widget on the homepage.
    salesCatalog homeWidgetImageMap Promotion2_Image Image URL New Customer Promo Controls what image is mapped to the second promotion banner widget on the homepage.
    salesCatalog pdpWidgetImageMap TopAdBanner_Image Image URL promo-belt Controls what image is mapped to the top advertisement banner widget on the plan details page.
    salesCatalog pdpWidgetImageMap poFeatureBanner_Image Image URL home-promo Controls what image is mapped to the feature banner widget on the plan details page.
    salesCatalog pdpWidgetImageMap pdpPromotion1_Image Image URL Device Promotion Controls what image is mapped to the first promotion banner widget on the plan details page.
    salesCatalog pdpWidgetImageMap pdpPromotion2_Image Image URL New Customer Promo Controls what image is mapped to the second promotion banner widget on the plan details page.
    salesCatalog pdpWidgetCategoryMap TopAdBanner Category Name Streaming Promotion Controls what product category is mapped to the top advertisement banner widget on the plan details page.
    salesCatalog pdpWidgetCategoryMap poFeatureBanner_Image Category Name Promotion Controls what product category is mapped to the feature banner widget on the plan details page.
    salesCatalog pdpWidgetCategoryMap pdpPromotion1 Category Name Internet Promotion Controls what product category is mapped to the first promotion banner widget on the plan details page.
    salesCatalog pdpWidgetCategoryMap pdpPromotion2 Category Name Hotspot Accessory Promotion Controls what product category is mapped to the second promotion banner widget on the plan details page.
    salesCatalog plansGrid planGridBanner Image URL plans-grid-banner
    salesCatalog productsGrid productsGridBanner Image URL products-grid-banner
    salesCatalog myaccountwidgetCategoryMap MyAccountDiscountBanner Category Name Internet Promotion Controls what product category is mapped to the first discount banner on My Account page.
    salesCatalog myaccountwidgetCategoryMap MyAccountDiscountBanner_1 Category Name Internet Promotion Controls what product category is mapped to the second discount banner on My Account page.
    salesCatalog myaccountwidgetCategoryMap MyAccountDiscountBanner_2 Category Name Bundle Promotion Controls what product category is mapped to the third discount banner on My Account page.
    salesCatalog myaccountwidgetImageMap MyAccountDiscountBanner_Image Image URL img-1 Controls what image is mapped to the first discount banner on My Account page.
    salesCatalog myaccountwidgetImageMap MyAccountDiscountBanner_1_Image Image URL img-1 Controls what image is mapped to the second discount banner on My Account page.
    salesCatalog myaccountwidgetImageMap MyAccountDiscountBanner_2_Image Image URL img-1 Controls what image is mapped to the third discount banner on My Account page.
    salesCatalog orderCancellation cancellationReason Cancel Reason Strings Order Created by Mistake, Shipping Cost Too High, Product Price Too High,Found Cheaper Somewhere Else, Order Delay, Incorrect Billing Address, Need To Change Payment Method Defines the cancellation reasons that will be displayed to the customer when canceling an order.
    salesCatalog orderDuration orderDurationinDays Count in Days 30 Dictates the time period for fetching the orders to be shown on the order history page.
    salesCatalog defaultDiscountType discountType Discount Priority Limited Time Defines the priority of the discount type. This dicates what discounts are displayed on the plan and the device summary card when there are three or more discounts for an offer.
    salesCatalog upSellRecommendation popUpDuration Time 5 Secs Dictates how long the upsell recommendation pop up window will remain on the screen.
    salesCatalog crossSellRecommendation maxItemsToDisplay Item Count 3 Dictates how many cross recommendations will be shown to the shopper.
    footerLinks footerLinksMap siteMapLabel siteMap siteMap
    footerLinks footerLinksMap termsOfUseAndPrivacyLabel terms terms
    footerLinks footerLinksMap countrySelectorLabel countrySele countrySele
    footerLinks footerLinksMap cookiePreferencesLabel cookiePref cookiePref
    B2CLinks whySupremoLabel ourCoverageLabel ourCovrage ourCovrage
    B2CLinks whySupremoLabel supremoAnd5GLabel supremo5G supremo5G
    B2CLinks purchasingOnlineLabel bestSellingPhonesLabel bestSelling bestSelling
    B2CLinks purchasingOnlineLabel specialDealsLabel specialDeals specialDeals
    B2CLinks purchasingOnlineLabel deviceAccessoriesLabel deviceAccess deviceAccess
    B2CLinks helpLabel generalHelpLabel generalHelp generalHelp
    B2CLinks helpLabel deviceHelpLabel deviceHelp deviceHelp
    B2CLinks helpLabel faqsLabel faqs faqs
    B2CLinks contactUsLabel returnsLabel returns returns
    B2CLinks contactUsLabel lostOrStolenDevicesLabel lostOrStolen lostOrStolen
    B2CLinks contactUsLabel repairsLabel repairs repairs
    B2CLinks supremoLabel aboutUsLabel about about
    B2CLinks supremoLabel careersLabel careers careers
    B2CLinks supremoLabel findAStoreLabel fas fas