GET v4/store/settings

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

StoreSettings
NameDescriptionTypeAdditional information
widgets

string

None.

currency

string

None.

currencySymbol

string

None.

secondaryCurrency

string

None.

secondaryCurrencySymbol

string

None.

conversionRate

decimal number

None.

language

string

None.

storeType

string

None.

pricingPlan

string

None.

newsletterText

string

None.

customMessageCartReview

string

None.

customMessageCheckout

string

None.

customMessageEmail

string

None.

customBehavior

string

None.

useColorBullets

boolean

None.

showBrandBanners

boolean

None.

showSecondaryCurrency

boolean

None.

showCustomOfferTag

boolean

None.

showCustomTag

boolean

None.

showSubscribeNewsletter

boolean

None.

giveCouponForNewsletter

boolean

None.

showCartReviewBanner

boolean

None.

hasDigitalDownloads

boolean

None.

showWrapGift

boolean

None.

websiteStatus

string

None.

showTopbar

boolean

None.

primaryColor

string

None.

secondaryColor

string

None.

accentColor

string

None.

topbarTextColor

string

None.

topbarBackgroundColor

string

None.

footerTextColor

string

None.

footerBackgroundColorTop

string

None.

footerBackgroundColorBottom

string

None.

showBreadcrumbImage

boolean

None.

breadcrumbImageUrl

string

None.

breadcrumbFrameColor

string

None.

breadcrumbTextColor

string

None.

directory

string

None.

navbarStyle

string

None.

navbarTextColor

string

None.

navbarBackgroundColor

string

None.

fontFamily

string

None.

fontSize

string

None.

footerStyle

string

None.

productListLayout

string

None.

productViewLayout

string

None.

pixelId

string

None.

googleAnalyticsId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "widgets": "sample string 1",
  "currency": "sample string 2",
  "currencySymbol": "sample string 3",
  "secondaryCurrency": "sample string 4",
  "secondaryCurrencySymbol": "sample string 5",
  "conversionRate": 6.0,
  "language": "sample string 7",
  "storeType": "sample string 8",
  "pricingPlan": "sample string 9",
  "newsletterText": "sample string 10",
  "customMessageCartReview": "sample string 11",
  "customMessageCheckout": "sample string 12",
  "customMessageEmail": "sample string 13",
  "customBehavior": "sample string 14",
  "useColorBullets": true,
  "showBrandBanners": true,
  "showSecondaryCurrency": true,
  "showCustomOfferTag": true,
  "showCustomTag": true,
  "showSubscribeNewsletter": true,
  "giveCouponForNewsletter": true,
  "showCartReviewBanner": true,
  "hasDigitalDownloads": true,
  "showWrapGift": true,
  "websiteStatus": "sample string 24",
  "showTopbar": true,
  "primaryColor": "sample string 26",
  "secondaryColor": "sample string 27",
  "accentColor": "sample string 28",
  "topbarTextColor": "sample string 29",
  "topbarBackgroundColor": "sample string 30",
  "footerTextColor": "sample string 31",
  "footerBackgroundColorTop": "sample string 32",
  "footerBackgroundColorBottom": "sample string 33",
  "showBreadcrumbImage": true,
  "breadcrumbImageUrl": "sample string 35",
  "breadcrumbFrameColor": "sample string 36",
  "breadcrumbTextColor": "sample string 37",
  "directory": "sample string 38",
  "navbarStyle": "sample string 39",
  "navbarTextColor": "sample string 40",
  "navbarBackgroundColor": "sample string 41",
  "fontFamily": "sample string 42",
  "fontSize": "sample string 43",
  "footerStyle": "sample string 44",
  "productListLayout": "sample string 45",
  "productViewLayout": "sample string 46",
  "pixelId": "sample string 47",
  "googleAnalyticsId": "sample string 48"
}

application/xml, text/xml

Sample:
<StoreSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <accentColor>sample string 28</accentColor>
  <breadcrumbFrameColor>sample string 36</breadcrumbFrameColor>
  <breadcrumbImageUrl>sample string 35</breadcrumbImageUrl>
  <breadcrumbTextColor>sample string 37</breadcrumbTextColor>
  <conversionRate>6</conversionRate>
  <currency>sample string 2</currency>
  <currencySymbol>sample string 3</currencySymbol>
  <customBehavior>sample string 14</customBehavior>
  <customMessageCartReview>sample string 11</customMessageCartReview>
  <customMessageCheckout>sample string 12</customMessageCheckout>
  <customMessageEmail>sample string 13</customMessageEmail>
  <directory>sample string 38</directory>
  <fontFamily>sample string 42</fontFamily>
  <fontSize>sample string 43</fontSize>
  <footerBackgroundColorBottom>sample string 33</footerBackgroundColorBottom>
  <footerBackgroundColorTop>sample string 32</footerBackgroundColorTop>
  <footerStyle>sample string 44</footerStyle>
  <footerTextColor>sample string 31</footerTextColor>
  <giveCouponForNewsletter>true</giveCouponForNewsletter>
  <googleAnalyticsId>sample string 48</googleAnalyticsId>
  <hasDigitalDownloads>true</hasDigitalDownloads>
  <language>sample string 7</language>
  <navbarBackgroundColor>sample string 41</navbarBackgroundColor>
  <navbarStyle>sample string 39</navbarStyle>
  <navbarTextColor>sample string 40</navbarTextColor>
  <newsletterText>sample string 10</newsletterText>
  <pixelId>sample string 47</pixelId>
  <pricingPlan>sample string 9</pricingPlan>
  <primaryColor>sample string 26</primaryColor>
  <productListLayout>sample string 45</productListLayout>
  <productViewLayout>sample string 46</productViewLayout>
  <secondaryColor>sample string 27</secondaryColor>
  <secondaryCurrency>sample string 4</secondaryCurrency>
  <secondaryCurrencySymbol>sample string 5</secondaryCurrencySymbol>
  <showBrandBanners>true</showBrandBanners>
  <showBreadcrumbImage>true</showBreadcrumbImage>
  <showCartReviewBanner>true</showCartReviewBanner>
  <showCustomOfferTag>true</showCustomOfferTag>
  <showCustomTag>true</showCustomTag>
  <showSecondaryCurrency>true</showSecondaryCurrency>
  <showSubscribeNewsletter>true</showSubscribeNewsletter>
  <showTopbar>true</showTopbar>
  <showWrapGift>true</showWrapGift>
  <storeType>sample string 8</storeType>
  <topbarBackgroundColor>sample string 30</topbarBackgroundColor>
  <topbarTextColor>sample string 29</topbarTextColor>
  <useColorBullets>true</useColorBullets>
  <websiteStatus>sample string 24</websiteStatus>
  <widgets>sample string 1</widgets>
</StoreSettings>