Docs
Storefront
Stencil
Themes
Page context
Theme object reference
Schemas

banners

Elements of marketing banners at pageʼs top and/or bottom.

global {{banners}} object

Handlebars Expressions

  • {{banners}},
  • {{{banners}}}

Handlebars Formatting Exception Where a banner contains HTML, the banner helper must be placed in triple braces, as in this example {{{banners}}}. (Double braces would escape the HTML.)

Limits

  • {{banners}} will only return the first 50 banners on each page.

  • bottom    array[string]

    Array of HTML content/strings, for custom bottom-banner content; banners are populated from the BigCommerce control panel

  • top    array[string]

    Array of HTML content/strings, for custom top-banner content; banners are populated from the BigCommerce control panel

blog

brand

brand_results

{{brand_results}} array

  • url    string

    Example: https://www.example/test-brand/

  • name    string

    Example: Test brand

brands

breadcrumbs

Defines a pageʼs breadcrumbs. Available on virtually all pages that have a breadcrumb trail.

global {{breadcrumbs}} array

Handlebars Expression {{breadcrumbs}}

  • name    string

    Displayed name of this breadcrumb element.

  • url    string

    URL of this breadcrumb element.

carousel

A list of images, text, and style assets for a storefront’s image slide show.

{{carousel}} array

Handlebars Expression {{carousel}}

  • slides    array[object]

    Object containing properties for each slide in the slideshow.

  • swap_frequency    integer

    Indicates how often (in seconds) the slides will change; the value must be between 1 and 90,000 seconds.

cart

The cart-specific properties for the current session.

{{cart}} object available to templates/pages/cart.html; contains cart_id if one exists.

Handlebars Expression: {{cart}}

  • additional_checkout_buttons    array[string]

    Generates checkout buttons for third-party payments (PayPal, Google Checkout, etc.)

  • coupons    array[object]

    List of coupons applied to the cart; default sorting is by coupon ID, from lowest to highest.

  • discount    object

    Discount being applied to the cart in the current session.

  • gift_certificates    array[object]

    List of gift certificates applied to the cart.

  • gift_wrapping_cost    object

    Price object that defines the cost associated with adding gift wrapping to the items in the cart.

  • grand_total    object

    Price object that defines the total cost of all the items in the cart. Incorporates estimated shipping, discounts, taxes, and gift wrapping.

  • items    array[object]

  • quantity    integer

  • shipping_handling    object

    Current configuration of the shipping estimator for this session’s current cart; will be null/undefined if the cart contains no physical products.

  • show_multiple_address_shipping    boolean

    Boolean: If > 1 physical items are in the cart, and checkout button is displayed: whether to also display the "Ship to multiple addresses" / "Multiple Shipping Addresses" user option.

  • show_primary_checkout_button    boolean

    Boolean that determines whether to show a checkout button.

  • status_messages    array[object]

  • sub_total    object

    Price object that defines the total cost of all the items in the cart. Might or might not include tax, based on the tax display settings the merchant has configured. Excludes shipping, discounts, and gift wrapping.

  • taxes    array[object]

    List of all applicable taxes for the cart.

cart_id

Returns the cart ID if one exists. To return more cart information use the Storefront Cart API.

global {{cart_id}}

Handlebars Expression: {{cart_id}}

categories

category

category_results

{{category_results}} array

  • url    string

    Example: https://www.example/card-testing/

  • name    string

    Example: Card Testing

checkout

Used to access checkout content and data in templates\pages\order-confirmation.html.

The {{checkout}} object is available to checkout and order confirmation templates and components.

Handlebars Expression: {{checkout.*}}

  • order_confirmation_content    string

    Default content from checkout template.
    Example: " <script>\n window.checkoutVariantIdentificationToken = '{{Token}}';\n </script>\n\n <script>\n document.body.style.display = 'none';\n </script>\n\n <script src=\"https://cdn11.bigcommerce.com/shared/microapp/checkout/dist/loader-1.122.1.js\"></script>\n\n <script>\n checkoutLoader.loadFiles({ publicPath: 'https://cdn11.bigcommerce.com/shared/microapp/checkout/dist' })\n .then(function(app) {\n document.body.style.display = '';\n\n app.renderOrderConfirmation({\n orderId: '1836',\n containerId: 'checkout-app',\n sentryConfig: {\"release\":\"checkout-js@1.122.1\",\"whitelistUrls\":[\"https:\\/\\/cdn11.bigcommerce.com\\/shared\\/microapp\\/checkout\\/dist\"],\"dsn\":\"https:\\/\\/418e8e81a209403e9c8740c4fdbff5a6@sentry.io\\/1542560\",\"environment\":\"production\",\"tags\":{\"environment\":\"production\",\"tier\":1}},\n });\n });\n </script>\n\n <div id=\"checkout-app\"></div>\n\n<script type=\"text/javascript\" src=\"https://cdn11.bigcommerce.com/shared/js/datatags-a6c27a4dafebddd5845000c8abc99b2096434171.js\" defer></script>\n<script type=\"text/javascript\">\nwindow.addEventListener('DOMContentLoaded', function () { window.initDataTags([], [], window.analytics, {\"channel\":{\"id\":0,\"name\":\"default\",\"type\":\"default\"}}); })\n</script>\n<script type=\"text/javascript\" src=\"https://cdn11.bigcommerce.com/shared/js/csrf-protection-header-b572e5526f6854c73a5e080ef15a771f963740ae.js\"></script>\n\n"

  • checkout_head    string

    Default content from checkout <head>.
    Example: "<base href=\"/\" target=\"_top\">\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1, maximum-scale=1\">\n<link href=\"https://cdn11.bigcommerce.com/shared/css/open_sans-5ec63c5b7015207649f715d5bf81d7d45e5a5496.css\" rel=\"stylesheet\" type=\"text/css\">\n\n\n <link href=\"https://cdn11.bigcommerce.com/shared/microapp/checkout/dist/checkout-ffd3ba3c.css\" rel=\"stylesheet\" type=\"text/css\">\n\n<!-- Start Tracking Code for analytics_facebook -->\n\n<script>\n!function(f,b,e,v,n,t,s){if(f.fbq)return;n=f.fbq=function(){n.callMethod?n.callMethod.apply(n,arguments):n.queue.push(arguments)};if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0';n.queue=[];t=b.createElement(e);t.async=!0;t.src=v;s=b.getElementsByTagName(e)[0];s.parentNode.insertBefore(t,s)}(window,document,'script','https://connect.facebook.net/en_US/fbevents.js');\n\nfbq('set', 'autoConfig', 'false', '419172936004242');\nfbq('dataProcessingOptions', ['LDU'], 0, 0);\nfbq('init', '419172936004242', {\"em\":\"patrick.p@ecommerce.com\",\"fn\":\"Updated via v3 API\",\"ln\":\"Puente\"});\nfbq('set', 'agent', 'plbigcommerce1.2', '419172936004242');\n\nwindow.onload = function() {\n var productIdMap = {},\n productIdsOnPage = getUniqueProductIdsOnPage(),\n pathName = window.location.pathname;\n\n fbq('track', 'PageView', {}, \"\");\n\n // Search events start -- only fire if the shopper lands on the /search.php page\n if (pathName.indexOf('/search.php') === 0 && getUrlParameter('search_query')) {\n fbq('track', 'Search', {\n content_ids: productIdsOnPage,\n search_string: getUrlParameter('search_query')\n });\n }\n // Search events end\n\n // Wishlist events start -- only fire if the shopper attempts to add an item to their wishlist\n if (pathName.indexOf('/wishlist.php') === 0 && getUrlParameter('added_product_id')) {\n fbq('track', 'AddToWishlist', {\n content_ids: [getUrlParameter('added_product_id')]\n });\n }\n // Wishlist events end\n\n // Lead events start -- only fire if the shopper subscribes to newsletter\n if (pathName.indexOf('/subscribe.php') === 0 && getUrlParameter('result') === 'success') {\n fbq('track', 'Lead', {});\n }\n // Lead events end\n\n // Registration events start -- only fire if the shopper registers an account\n if (pathName.indexOf('/login.php') === 0 && getUrlParameter('action') === 'account_created') {\n fbq('track', 'CompleteRegistration', {}, \"\");\n }\n // Registration events end\n\n // Checkout events start -- only fire if the shopper lands on a /checkout* page\n if (pathName === '/checkout.php' || /^\\/(embedded-)?checkout$/.test(pathName)) {\n window.sessionStorage.setItem('fb_conversion_key_7bc711f7-0ac8-4fa8-9a43-9c72c4324faf', 'true');\n\n if (getUrlParameter('action') === 'process_payment') {\n fbq('track', 'AddPaymentInfo');\n } else {\n fbq('track', 'InitiateCheckout');\n }\n }\n // Checkout events end\n\n function getUniqueProductIdsOnPage() {\n return Array.prototype.reduce.call(document.querySelectorAll('[data-product], [data-product-id]'), function(acc, obj) {\n var productId = obj.getAttribute('data-product') || obj.getAttribute('data-product-id');\n\n if (!productIdMap[productId]) {\n productIdMap[productId] = true;\n acc.push(productId);\n }\n\n return acc;\n }, []);\n }\n\n function getUrlParameter(name) {\n var cleanName = name.replace(/[\\[]/, '\\[').replace(/[\\]]/, '\\]');\n var regex = new RegExp('[\\?&]' + cleanName + '=([^&#]*)');\n var results = regex.exec(window.location.search);\n return results === null ? '' : decodeURIComponent(results[1].replace(/\\+/g, ' '));\n }\n}\n</script>\n<noscript><img height=\"1\" width=\"1\" style=\"display:none\" alt=\"null\" src=\"https://www.facebook.com/tr?id=419172936004242&ev=PageView&noscript=1&a=plbigcommerce1.2&eid=\"/></noscript>\n\n<!-- End Tracking Code for analytics_facebook -->\n\n<!-- Start Tracking Code for analytics_googleanalytics -->\n\n<script>\n !function(){var analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error(\"Segment snippet included twice.\");else{analytics.invoked=!0;analytics.methods=[\"trackSubmit\",\"trackClick\",\"trackLink\",\"trackForm\",\"pageview\",\"identify\",\"reset\",\"group\",\"track\",\"ready\",\"alias\",\"debug\",\"page\",\"once\",\"off\",\"on\"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.loadPlatform=function(t,e,a,o){window[o||\"analytics\"]=analytics;window._analytics_js_global_name=o;analytics.platformSettings=e;analytics.platformPlan=a;var r=document.createElement(\"script\");r.type=\"text/javascript\";r.defer=!0;r.src=\"https://cdn11.bigcommerce.com/shared/js/storefront/analytics-c7af4d4e323cc1137c45f692e81cae05fd2a3986.js\";var i=document.getElementsByTagName(\"script\")[0];i.parentNode.insertBefore(r,i)};analytics.SNIPPET_VERSION=\"4.0.0_platform\";\n analytics.loadPlatform(\"\", { \"Google Analytics\": {\"enhancedLinkAttribution\":true,\"enhancedEcommerce\":true,\"includeSearch\":true,\"sendUserId\":true,\"trackingId\":\"UA-42625534-3\",\"dimensions\":[],\"metrics\":[]} }, {}, \"analytics\");\n analytics.identify('1');\n analytics.page();\n \n analytics.ready(function () {\n ga('require', 'ec');\n ga('require', 'linker');\n ga('linker:autoLink', [\"hatertron.ninja\",\"ad.buybutton.store\",\"store-iu88q6epfh.mybigcommerce.com\",\"www.store-iu88q6epfh.mybigcommerce.com\"]);\n });\n }}();\n</script>\n\n<!-- End Tracking Code for analytics_googleanalytics -->\n\n<!-- Start Tracking Code for analytics_segment -->\n\n<script>\n!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error(\"Segment snippet included twice.\");else{analytics.invoked=!0;analytics.methods=[\"trackSubmit\",\"trackClick\",\"trackLink\",\"trackForm\",\"pageview\",\"identify\",\"reset\",\"group\",\"track\",\"ready\",\"alias\",\"debug\",\"page\",\"once\",\"off\",\"on\"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t,e){var n=document.createElement(\"script\");n.type=\"text/javascript\";n.async=!0;n.src=\"https://cdn.segment.com/analytics.js/v1/\"+t+\"/analytics.min.js\";var a=document.getElementsByTagName(\"script\")[0];a.parentNode.insertBefore(n,a);analytics._loadOptions=e};analytics.SNIPPET_VERSION=\"4.1.0\";\nanalytics.load(\"BWE8IJKQWfh59kKY6FyICCnX0Uz8qMto\");\nanalytics.identify('1');\nanalytics.page();\n}}();\n</script>\n\n<!-- End Tracking Code for analytics_segment -->\n\n<!-- Start Tracking Code for analytics_siteverification -->\n\n<!-- SITE VERIFICATION TAGS -->\n\n<!-- End Tracking Code for analytics_siteverification -->\n\n\n\n <!-- Start conversion code for analytics_affiliate -->\n <!-- testing conversion tracking -->\n<script>\n// window.location = \"https://example.org?order_id=1836&email=patrick.p@ecommerce.com\"\n</script>\n <!-- End conversion code for analytics_affiliate -->\n \n\n <!-- Start conversion code for analytics_googleanalytics -->\n \n <script type=\"text/javascript\">\n if(typeof(pageTracker) != 'undefined') {\n pageTracker._addTrans(\n '1836',\n 'My Sandbox',\n '9.7400',\n '0.7400',\n '0.0000',\n 'Austin',\n 'Texas',\n 'United States',\n 'USD',\n {id: '0', name: 'default', type: 'storefront'}\n );\n \n pageTracker._addItem(\n '1836',\n '50920',\n 'replacement digital product',\n '',\n '10.8222',\n '1'\n );\n \n pageTracker._trackTrans();\n }\n </script>\n <!-- End conversion code for analytics_googleanalytics -->\n \n<script type=\"text/javascript\">\nvar BCData = {\"csrf_token\":\"{{token}}\"};\n</script>\n\n\n"

  • order    object

    {{checkout.order}} object available to order confirmation templates and components.

  • header_image    string

    The image src of the header.

  • id    string

    the cart and checkout id
    Example: 2343eb66-3c41-4966-a539-d8af36d3fc47

comparisons

Property to display an array of products on product comparison pages. (Called on the default <theme-name>/templates/pages/compare.html template.)

{{comparisons}} array

Handlebars Expression: {{comparisons}}

  • availability    string

    How long this product usually takes to ship.

  • brand    object

    Object containing brand data for this product.

  • category    array[string]

  • custom_fields    array[object]

    Array of additional product details as name-value pairs. For example, size, color, bookʼs ISBN, DVDʼs release date, etc.

  • date_added    string

  • demo    boolean

  • has_options    boolean

  • id    number

  • image    object

  • images    array[object]

  • low_stock_level    null

  • name    string

  • num_reviews    number

  • pre_order    boolean

  • price    object

  • qty_in_cart    number

  • rating    number

  • show_cart_action    boolean

  • sku    string

  • stock_level    null

  • summary    string

  • url    string

  • weight    object

    URL to remove this product/column from the comparison.

content_results

{{content_results}} array

  • title    string

    Example: test

  • url    string

    Example: https://www.example/completely/configurable

  • content    string

    Example: test

  • type    string

    Example: Post

countries

The {{countries}} array available to templates/pages/account/payment-methods.html; used in country and state dropdowns when submitting add payment form.

Handlebars Expression: {{countries}}

  • currency    array[object]

    Details about the currency associated with the country.

  • id    integer

    The country ID; BigCommerce-generated.
    Example: 2

  • iso2    string

    The countryʼs ISO 3166 Alpha-2 code.
    Example: GB

  • iso3    string

    The countryʼs ISO 3166 Alpha-3 code.
    Example: GBR

  • name    string

    The countryʼs display name.
    Example: United Kingdom

  • selected    boolean

create_account

currency_selector

A list of all supported currencies, and the currency that is actively in use in the storefront.

global {{currency_selector}}

Handlebars Expression: {{currency_selector}}

  • active_currency_id    string

    ID of the currency actively in use in the storefront.

  • active_currency_flag    string

    Country flag used to represent the active currency.

  • active_currency_name    string

    Name of the active currency.

  • active_currency_code    string

    Code for the active currency.

  • currencies    array[object]

    List of all the currencies supported for this storefront.

customer

customer_group_id

global {{customer_group_id}}

customer_group_name

global {{customer_group_name}}

downloads

Property for digital (non-physical) products. Exposed on the default <theme-name>/templates/pages/account/download-item.html template.

Handlebars Expression: {{downloads}}

  • description    string

    Example: screenshot_video

  • downloads_remaining    number

    Example: 10

  • expired    boolean

  • id    string

    Example: 184

  • name    string

    Example: screenshot.mp3

  • size    string

    Example: 16.53 KB

  • url    string

    Example: "/account.php?action=download_item&data=OTcsMTE5LDE4NCw0N2VjZTkyM2NlNDkzOTBiOGQ0MmZlZWMwYWQ1OTEzMSwxLDE0ODA5MTMwNTcwMDM1NjQ2OTQwNDc2ODIzMTA3NzU1ODg="

faceted_search

global {{faceted_search}}; provides data for searching by category or brand.

Handlebars Expression: {{faceted_search}}

  • facets    string

    List of all search facets available.

  • selected    array[object]

    Container for the selected search facets (selected facets contain properties below)

footer

The footer content for each storefront page.

global {{footer}} object

Handlebars Expression: {{footer}}

  • sitemap_url    string

    The URL to the sitemap, based on store’s SEO setting.

  • scripts    string

    Scripts to be loaded after the HTML has loaded; includes performance metrics.

forms

forms_contact

  • captcha_url    string

    Example: "https://arabic-store.mybigcommerce.com/captcha.php?1062"

  • company    boolean

  • name    boolean

  • order    boolean

  • page_id    string

    Example: 4

  • phone    boolean

  • recaptcha    array[object]

  • rma    boolean

  • text    string

    Example: "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>"

head

global {{head}} object containing data configured for the HTML <head> element.

Handlebars Expression: {{head}}

  • favicon    string

    The storeʼs favicon.

  • meta_tags    string

    Meta tags to improve store SEO.

  • scripts    string

    Scripts to be loaded in the <head> tag.

  • stylesheets    string

    CSS files to be included.

  • title    string

    Current pageʼs title.

is_ajax

global {{is_ajax}} boolean; returns true if the current request is an AJAX request

Handlebars Expression: {{is_ajax}}

No properties available for this object.

order

page

{{page}} object present on content pages, forms, and RSS feeds.

Handlebars Expression: {{page}}

  • breadcrumbs    array[]

    Present if page has ancestors.

  • content    string

    HTML content of the page

  • feed    array[object]

    Present if page is an RSS feed page.

  • id    integer

  • sub_pages    array[object]

    Array of child pages

  • title    string

    Title of this child page

page_type

A string representing the type of page currently displayed.

global {{page_type}} string.

Handlebars Expression: {{page_type}}

All possible values for {{page-type}} are:

  • account_orderstatus
  • account_order
  • account_addressbook
  • shippingaddressform
  • account_new_return
  • add-wishlist
  • account_recentitems
  • account_downloaditem
  • editaccount
  • account_inbox
  • account_saved_return
  • account_returns
  • account_paymentmethods
  • account_addpaymentmethod
  • account_editpaymentmethod
  • login
  • createaccount_thanks
  • createaccount
  • getnewpassword
  • forgotpassword
  • blog
  • blog_post
  • brand
  • brands
  • cart
  • checkout
  • category*
  • compare
  • page_contact_form
  • error
  • 404
  • giftcertificates
  • giftcertificates_balance
  • giftcertificates_redeem
  • default*
  • orderconfirmation
  • page*
  • product*
  • amp_product_options
  • search
  • rss
  • sitemap
  • newsletter_subscribe
  • wishlist
  • wishlists

The four most-commonly-used values for {{page_type}} are marked with asterisks.

pages

global {{pages}} object containing storefront content page data

Handlebars Expression: {{pages}}

  • URL    string

    URL of the page.

  • children    array[object]

    List of child pages for this page.

  • name    string

    Name of the page.

pagination

price

product

product_results

{{product_results}}

  • products    array[object]

  • rating    integer

  • num_reviews    integer

  • price    object

  • tax_label    string

    Example: Tax

  • category    array[object]

products

remote_api_scripts

Empty array. No properties are available for this object. Handlebars Expression: {{remote_api_scripts}}

settings

shipments

{{shipments}} array available to templates/pages/account/orders/details.html

  • date_shipped    string

    shipping date for this shipment

  • shipping_method    string

    shipping method for this shipment

  • shipping_provider    string

    shipping carrier for this shipment

  • shipping_track    object

    tracking information for this shipment

  • show_shipping_method    boolean

    boolean indicating whether shipping method should be displayed to customer or not

shipping_messages

{{shipping_messages}} object available to templates/pages/home.html

shop_by_brand

Objects to enable customers to shop by brand. Returns top 10 brands, by product count. (Called on the default templates/components/brand/sidebar.html and templates/components/common/footer.html partials.)

global {{shop_by_brand}} array of top 10 brands by product count.

Handlebars Expression: {{shop_by_brand}}

  • count    string

    Number of products matching this brand.

  • id    string

    ID for this brand.

  • name    string

    Name of this brand.

  • url    string

    URL for this brand.

sitemap

A list of all sitemap properties for this BigCommerce storefront: pages, categories, and brands.

{{sitemap}} object available to templates/pages/sitemap.html.

Handlebars Expression: {{sitemap}}

  • body    array[object]

    List of all sitemap subsections

  • label    string

    Subsection title (pages, categories, brands).

  • show_all_link    boolean

  • subsection_url    string

    URL to subsection content (pages, categories, brands) of the sitemap.

  • title    string

social_media

template_file

global {{template_file}} string

theme_settings

global {{theme_settings}} object

  • alert-backgroundColor    string

  • alert-color    string

  • alert-color-alt    string

  • applePay-button    string

  • blockquote-cite-font-color    string

  • blog_size    string

  • body-bg    string

  • body-font    string

  • brand_size    string

  • brandpage_products_per_page    integer

  • button--default-borderColor    string

  • button--default-borderColorActive    string

  • button--default-borderColorHover    string

  • button--default-color    string

  • button--default-colorActive    string

  • button--default-colorHover    string

  • button--disabled-backgroundColor    string

  • button--disabled-borderColor    string

  • button--disabled-color    string

  • button--icon-svg-color    string

  • button--primary-backgroundColor    string

  • button--primary-backgroundColorActive    string

  • button--primary-backgroundColorHover    string

  • button--primary-color    string

  • button--primary-colorActive    string

  • button--primary-colorHover    string

  • card--alternate-backgroundColor    string

  • card--alternate-borderColor    string

  • card--alternate-color--hover    string

  • card-figcaption-button-background    string

  • card-figcaption-button-color    string

  • card-title-color    string

  • card-title-color-hover    string

  • carousel-arrow-bgColor    string

  • carousel-arrow-borderColor    string

  • carousel-arrow-color    string

  • carousel-bgColor    string

  • carousel-description-color    string

  • carousel-dot-bgColor    string

  • carousel-dot-color    string

  • carousel-dot-color-active    string

  • carousel-title-color    string

  • categorypage_products_per_page    integer

  • checkRadio-backgroundColor    string

  • checkRadio-borderColor    string

  • checkRadio-color    string

  • color-black    string

  • color-error    string

  • color-errorLight    string

  • color-grey    string

  • color-greyDark    string

  • color-greyDarker    string

  • color-greyDarkest    string

  • color-greyLight    string

  • color-greyLighter    string

  • color-greyLightest    string

  • color-greyMedium    string

  • color-info    string

  • color-infoLight    string

  • color-primary    string

  • color-primaryDark    string

  • color-primaryDarker    string

  • color-primaryLight    string

  • color-secondary    string

  • color-secondaryDark    string

  • color-secondaryDarker    string

  • color-success    string

  • color-successLight    string

  • color-textBase    string

  • color-textBase--active    string

  • color-textBase--hover    string

  • color-textHeading    string

  • color-textLink    string

  • color-textLink--active    string

  • color-textLink--hover    string

  • color-textSecondary    string

  • color-textSecondary--active    string

  • color-textSecondary--hover    string

  • color-warning    string

  • color-warningLight    string

  • color-white    string

  • color-whitesBase    string

  • color_badge_product_sale_badges    string

  • color_hover_product_sale_badges    string

  • color_text_product_sale_badges    string

  • container-border-global-color-base    string

  • container-fill-base    string

  • container-fill-dark    string

  • default_image_brand    string

  • default_image_gift_certificate    string

  • default_image_product    string

  • dropdown--quickSearch-backgroundColor    string

  • dropdown--wishList-backgroundColor    string

  • fontSize-h1    integer

  • fontSize-h2    integer

  • fontSize-h3    integer

  • fontSize-h4    integer

  • fontSize-h5    integer

  • fontSize-h6    integer

  • fontSize-root    integer

  • footer-backgroundColor    string

  • form-label-font-color    string

  • gallery_size    string

  • geotrust_ssl_common_name    string

  • geotrust_ssl_seal_size    string

  • header-backgroundColor    string

  • headings-font    string

  • hide_blog_page_heading    boolean

  • hide_breadcrumbs    boolean

  • hide_category_page_heading    boolean

  • hide_contact_us_page_heading    boolean

  • hide_content_navigation    boolean

  • hide_page_heading    boolean

  • homepage_blog_posts_count    integer

  • homepage_featured_products_column_count    integer

  • homepage_featured_products_count    integer

  • homepage_new_products_column_count    integer

  • homepage_new_products_count    integer

  • homepage_show_carousel    boolean

  • homepage_show_carousel_arrows    boolean

  • homepage_stretch_carousel_images    boolean

  • homepage_top_products_column_count    integer

  • homepage_top_products_count    integer

  • icon-color    string

  • icon-color-hover    string

  • icon-ratingEmpty    string

  • icon-ratingFull    string

  • input-bg-color    string

  • input-border-color    string

  • input-border-color-active    string

  • input-disabled-bg    string

  • input-font-color    string

  • label-backgroundColor    string

  • label-color    string

  • loadingOverlay-backgroundColor    string

  • logo-position    string

  • logo_fontSize    integer

  • logo_size    string

  • navPages-color    string

  • navPages-color-hover    string

  • navPages-subMenu-backgroundColor    string

  • navPages-subMenu-separatorColor    string

  • navUser-color    string

  • navUser-color-hover    string

  • navUser-dropdown-backgroundColor    string

  • navUser-dropdown-borderColor    string

  • navUser-indicator-backgroundColor    string

  • navigation_design    string

  • optimizedCheckout-backgroundImage    string

  • optimizedCheckout-backgroundImage-size    string

  • optimizedCheckout-body-backgroundColor    string

  • optimizedCheckout-buttonPrimary-backgroundColor    string

  • optimizedCheckout-buttonPrimary-backgroundColorActive    string

  • optimizedCheckout-buttonPrimary-backgroundColorDisabled    string

  • optimizedCheckout-buttonPrimary-backgroundColorHover    string

  • optimizedCheckout-buttonPrimary-borderColor    string

  • optimizedCheckout-buttonPrimary-borderColorActive    string

  • optimizedCheckout-buttonPrimary-borderColorDisabled    string

  • optimizedCheckout-buttonPrimary-borderColorHover    string

  • optimizedCheckout-buttonPrimary-color    string

  • optimizedCheckout-buttonPrimary-colorActive    string

  • optimizedCheckout-buttonPrimary-colorDisabled    string

  • optimizedCheckout-buttonPrimary-colorHover    string

  • optimizedCheckout-buttonPrimary-font    string

  • optimizedCheckout-buttonSecondary-backgroundColor    string

  • optimizedCheckout-buttonSecondary-backgroundColorActive    string

  • optimizedCheckout-buttonSecondary-backgroundColorHover    string

  • optimizedCheckout-buttonSecondary-borderColor    string

  • optimizedCheckout-buttonSecondary-borderColorActive    string

  • optimizedCheckout-buttonSecondary-borderColorHover    string

  • optimizedCheckout-buttonSecondary-color    string

  • optimizedCheckout-buttonSecondary-colorActive    string

  • optimizedCheckout-buttonSecondary-colorHover    string

  • optimizedCheckout-buttonSecondary-font    string

  • optimizedCheckout-colorFocus    string

  • optimizedCheckout-contentPrimary-color    string

  • optimizedCheckout-contentPrimary-font    string

  • optimizedCheckout-contentSecondary-color    string

  • optimizedCheckout-contentSecondary-font    string

  • optimizedCheckout-discountBanner-backgroundColor    string

  • optimizedCheckout-discountBanner-iconColor    string

  • optimizedCheckout-discountBanner-textColor    string

  • optimizedCheckout-form-textColor    string

  • optimizedCheckout-formChecklist-backgroundColor    string

  • optimizedCheckout-formChecklist-backgroundColorSelected    string

  • optimizedCheckout-formChecklist-borderColor    string

  • optimizedCheckout-formChecklist-color    string

  • optimizedCheckout-formField-backgroundColor    string

  • optimizedCheckout-formField-borderColor    string

  • optimizedCheckout-formField-errorColor    string

  • optimizedCheckout-formField-inputControlColor    string

  • optimizedCheckout-formField-placeholderColor    string

  • optimizedCheckout-formField-shadowColor    string

  • optimizedCheckout-formField-textColor    string

  • optimizedCheckout-header-backgroundColor    string

  • optimizedCheckout-header-borderColor    string

  • optimizedCheckout-header-textColor    string

  • optimizedCheckout-headingPrimary-color    string

  • optimizedCheckout-headingPrimary-font    string

  • optimizedCheckout-headingSecondary-color    string

  • optimizedCheckout-headingSecondary-font    string

  • optimizedCheckout-link-color    string

  • optimizedCheckout-link-font    string

  • optimizedCheckout-link-hoverColor    string

  • optimizedCheckout-loadingToaster-backgroundColor    string

  • optimizedCheckout-loadingToaster-textColor    string

  • optimizedCheckout-logo-position    string

  • optimizedCheckout-logo-size    string

  • optimizedCheckout-orderSummary-backgroundColor    string

  • optimizedCheckout-orderSummary-borderColor    string

  • optimizedCheckout-show-backgroundImage    boolean

  • optimizedCheckout-step-backgroundColor    string

  • optimizedCheckout-step-borderColor    string

  • optimizedCheckout-step-textColor    string

  • overlay-backgroundColor    string

  • pace-progress-backgroundColor    string

  • paymentbuttons-paypal-color    string

  • paymentbuttons-paypal-fundingicons    boolean

  • paymentbuttons-paypal-label    string

  • paymentbuttons-paypal-layout    string

  • paymentbuttons-paypal-shape    string

  • paymentbuttons-paypal-size    string

  • paymentbuttons-paypal-tagline    boolean

  • pdp-custom-fields-tab-label    string

  • pdp-non-sale-price-label    string

  • pdp-price-label    string

  • pdp-retail-price-label    string

  • pdp-sale-price-label    string

  • price_ranges    boolean

  • product_list_display_mode    string

  • product_sale_badges    string

  • product_size    string

  • productgallery_size    string

  • productpage_related_products_count    integer

  • productpage_reviews_count    integer

  • productpage_similar_by_views_count    integer

  • productpage_videos_count    integer

  • productthumb_size    string

  • productview_thumb_size    string

  • searchpage_products_per_page    integer

  • select-arrow-color    string

  • select-bg-color    string

  • shop_by_brand_show_footer    boolean

  • shop_by_price_visibility    boolean

  • show_accept_amex    boolean

  • show_accept_discover    boolean

  • show_accept_mastercard    boolean

  • show_accept_paypal    boolean

  • show_accept_visa    boolean

  • show_copyright_footer    boolean

  • show_custom_fields_tabs    boolean

  • show_powered_by    boolean

  • show_product_details_tabs    boolean

  • show_product_dimensions    boolean

  • show_product_quantity_box    boolean

  • show_product_quick_view    boolean

  • show_product_reviews    boolean

  • show_product_weight    boolean

  • storeName-color    string

  • supported_card_type_icons    array[string]

  • swatch_option_size    string

  • thumb_size    string

  • zoom_size    string

urls

global {{urls}} object containing a collection of storefront pages and their sub-pages

  • auth    object

  • brands    string

  • cart    string

  • checkout    object

  • compare    string

  • contact_us_submit    string

  • gift_certificate    object

  • home    string

  • product    object

  • rss    object

  • search    string

  • sitemap    string

vault

{{vault}} object available to templates/pages/account/payment-methods.html.

Handlebars Expression: {{vault}}

  • access_token    string

    Required to submit add payment method form; otherwise, submission will fail with 401 Unauthorized.
    Example: {{token}}

  • expires_at    number

    Expiration Date in Unix Timestamp.
    Example: 1616614163

wishlist

Did you find what you were looking for?
config.jsonbanners