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.
bottomarray[string]
Array of HTML content/strings, for custom bottom-banner content; banners are populated from the BigCommerce control panel
toparray[string]
Array of HTML content/strings, for custom top-banner content; banners are populated from the BigCommerce control panel
blog
Blog-specific properties for the blog feature within BigCommerce storefronts. These objects are called on the default templates/components/blog/post.html
partial.
global
and template {{blog}}
objects
Handlebars Expression
{{blog}}
brand
The brand object for the page calling the object.
{{brand}}
object available to templates/pages/brand.html
Handlebars Expression: {{brand}}
configarray[object]
faceted_search_enabledboolean
Boolean that defines whether product-filtering search is enabled for the store.
facetsarray[object]
A list of all possible search filters for this brand.
image
metaarray[object]
namestring
Name of the brand
productsarray[]
An array of product card models.
search_errorboolean
selectedobject
An array of selected facets.
show_compareboolean
Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons.
statearray[object]
urlstring
URL of the brand page
brand_results
{{brand_results}} array
urlstring
Example: https://www.example/test-brand/
namestring
Example: Test brand
breadcrumbs
Defines a pageʼs breadcrumbs. Available on virtually all pages that have a breadcrumb trail.
global
{{breadcrumbs}}
array
Handlebars Expression {{breadcrumbs}}
carousel
A list of images, text, and style assets for a storefront’s image slide show.
{{carousel}}
array
Handlebars Expression {{carousel}}
slidesarray[object]
Object containing properties for each slide in the slideshow.
swap_frequencyinteger
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_buttonsarray[string]
Generates checkout buttons for third-party payments (PayPal, Google Checkout, etc.)
couponsarray[object]
List of coupons applied to the cart; default sorting is by coupon ID, from lowest to highest.
discountobject
Discount being applied to the cart in the current session.
gift_certificatesarray[object]
List of gift certificates applied to the cart.
gift_wrapping_costobject
Price object that defines the cost associated with adding gift wrapping to the items in the cart.
grand_totalobject
Price object that defines the total cost of all the items in the cart. Incorporates estimated shipping, discounts, taxes, and gift wrapping.
itemsarray[object]
quantityinteger
shipping_handlingobject
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_shippingboolean
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_buttonboolean
Boolean that determines whether to show a checkout button.
status_messagesarray[object]
sub_totalobject
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.
taxesarray[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
A array of category objects filled with all categories shown in the current page context; default sorting is by category ID, from lowest to highest
global
{{categories}}
array
Handlebars Expression: {{categories}}
category
The category object for the page calling the object. When retrieving a collection of categories, default sorting is by category id, from lowest to highest. Called on the default templates/pages/category.html
template, and on several partials in the <theme-name>/templates/components/
subdirectory: category/shop-by-price.html
and category/sidebar.html
.
Handlebars Expression: {{category}}
configarray[object]
descriptionstring
Merchant-defined description of the category.
detail_messagesarray[object]
Message displayed when a product is out of stock, and inventory settings are configured to redirect to a category: "Sorry, the product you tried to view is currently out of stock, here are some similar products we have available." (This phrasing is set by the BigCommerce App.)
faceted_search_enabledboolean
Boolean that defines whether product-filtering search is enabled for the store.
facetsarray[object]
Available search facets.
idinteger
Unique ID for the category.
image
metaarray[object]
namestring
Merchant-defined category name.
productsarray[]
selectedarray[object]
Selected search facets.
shop_by_pricearray[object]
Exposes price- and currency-related properties in both raw numeric, and formatted string, formats.
show_compareinteger
Boolean that defines whether to show controls for product comparison
statearray[object]
subcategoriesarray[object]
List of any child categories.
total_productsinteger
Count of the number of products in the category.
urlstring
category_results
{{category_results}} array
urlstring
Example: https://www.example/card-testing/
namestring
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_contentstring
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_headstring
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"
orderobject
{{checkout.order}}
object available to order confirmation templates and components.header_imagestring
The image
src
of the header.idstring
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}}
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}}
create_account
Object to enable the current customer to create a store account. (Called on the default <theme-name>/templates/pages/auth/create-account.html
template.)
Handlebars Expression: {{forms.create_account}}
continue_urlstring
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_idstring
ID of the currency actively in use in the storefront.
active_currency_flagstring
Country flag used to represent the active currency.
active_currency_namestring
Name of the active currency.
active_currency_codestring
Code for the active currency.
currenciesarray[object]
List of all the currencies supported for this storefront.
customer
{{customer}}
object available to templates and components with customer context such as page/contact-us-form.html
, common/subscription-form.html
, account/address-list.html
, account/messages-form.html
, and account/wishlist-list.html
.
Handlebars Expression: {{customer}}
addresses
customer_group_idnumber
ID of this customerʼs group.
customer_group_namestring
Name of this customerʼs group.
edit_stored_instrumentstring
emailstring
Customer’s email address.
idinteger
Customerʼs ID.
namestring
Customerʼs name.
num_new_messagesinteger
Number of unread messages for this customer.
num_wishlistsstring
Number of wishlists for this customer.
orders
payment_methods
phonestring
Customerʼs phone number.
recently_viewed_productsarray[]
returns
shipping_addressobject
Shipping address used for the order.
shipping_addresses
store_creditobject
Customerʼs store credit.
wishlists
downloads
Property for digital (non-physical) products. Exposed on the default <theme-name>/templates/pages/account/download-item.html
template.
Handlebars Expression: {{downloads}}
faceted_search
global
{{faceted_search}}
; provides data for searching by category or brand.
Handlebars Expression: {{faceted_search}}
facetsstring
List of all search facets available.
selectedarray[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_urlstring
The URL to the sitemap, based on store’s SEO setting.
scriptsstring
Scripts to be loaded after the HTML has loaded; includes performance metrics.
forms
{{forms}}
object available to pages and components with forms
Handlebars Expression: {{forms.edit_account}}
forms_contact
captcha_urlstring
Example: "https://arabic-store.mybigcommerce.com/captcha.php?1062"
companyboolean
nameboolean
orderboolean
page_idstring
Example: 4
phoneboolean
recaptchaarray[object]
rmaboolean
textstring
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}}
faviconstring
The storeʼs favicon.
meta_tagsstring
Meta tags to improve store SEO.
scriptsstring
Scripts to be loaded in the
<head>
tag.stylesheetsstring
CSS files to be included.
titlestring
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
The {{order}}
object available to templates and components with order context.
Handlebars Expression: {{order}}
billing_addressobject
Billing address used for the order.
commentsstring
datestring
Date of the order
has_multiple_shipping_addressesboolean
idinteger
Unique, system-generated ID
invoice_urlstring
is_completeboolean
Boolean indicating that the order has been completed
is_digitalstring
itemsarray[object]
List of items for the order.
last_updatedstring
order_instructionsstring
payment_methodstring
Customer’s payment method for this order (payment gateway)
reorder_urlstring
URL to place reorders for items in this order.
return_urlstring
returns_enabledinteger
Boolean that indicates whether merchant allows products from the order to be returned.
shipping_addressobject
Shipping address used for the order.
shipping_address_countstring
Number of shipping addresses the customer has specified for this order.
shipping_methodstring
statusstring
Order status code
status_messagesarray[object]
Status message associated with the status code for the order
status_textstring
Status text associated with the status code for the order.
totalobject
Price object that defines the order’s total value
total_rowsarray[object]
A list of “total” rows containing total pricing information
pickup_addressobject
brandstring
page
{{page}}
object present on content pages, forms, and RSS feeds.
Handlebars Expression: {{page}}
breadcrumbsarray[]
Present if page has ancestors.
contentstring
HTML content of the page
feedarray[object]
Present if page is an RSS feed page.
idinteger
sub_pagesarray[object]
Array of child pages
titlestring
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}}
URLstring
URL of the page.
childrenarray[object]
List of child pages for this page.
namestring
Name of the page.
pagination
{{pagination}}
object available to templates containing paginated lists, such as templates/pages/category.html
and templates/pages/brands.html
.
Handlebars Expression: {{pagination}}
product
Default property that provides detailed product data. Called on the default templates/pages/product.html
template, and on several partials in the templates/components/
subdirectory:
*account/returns-list.html
*cart/item-options.html
,
*products/add-to-cart.html
*products/event-date.html
*products/modals/writeReview.html
*products/price.html
*products/product-view.html
Handlebars Expression: {{product}}
AddThisServiceButtonMetastring
add_thisarray[object]
add_to_wishlist_urlstring
URL to add the product to the customer’s wishlist
availabilitystring
brandarray[object]
The company, product line, or trademark associated with the product.
bulk_discount_ratesarray[object]
List of discount rates for the current product
can_purchaseboolean
Boolean that indicates whether the product is available for purchase
cart_urlstring
URL to the customer’s shopping cart
categoryarray[string]
conditionstring
Product condition
customizationsarray[object]
Product customizations (for example, a T-shirt size); these correspond to configurable fields and numeric-text product options in the BigCommerce control panel
depthstring
The productʼs physical depth measurement.
descriptionstring
(HTML) description of the product
detail_messagesstring
Status messages for display at the top of the product page
gift_wrapping_availableboolean
Whether or not gift wrapping is enabled
gtinstring
Global Trade Item Number. An identifier for trade items that is incorporated into several product identification standards, such as ISBN, UPC, and EAN.
heightstring
The productʼs physical height measurement.
idstring
Unique ID for the product
imagesarray[object]
List of all images for this product, in Stencil image format (as configured in config.json; used with the getImage Handlebars helper)
main_imageobject
Primary image to display when the product details page loads
max_purchase_quantityinteger
Maximum quantity that can be purchased at once
meta_descriptionstring
meta_keywordsstring
Optional search keywords that merchants may enter in the control panel’s "Add a Product" or “Edit a Product” page, to characterize the product in meta tags and storefront searches
min_purchase_quantityinteger
Minimum quantity that can be purchased at once
mpnstring
Manufacturer Part Number. It is used to reference and identify a product.
num_reviewsinteger
Number of reviews the product has
options
out_of_stockboolean
Boolean that indicates whether the product is out of stock. Out of stock only applies to the default selection on page load. For example, if Product A is out of the "Small" size, but "Small" is selected by default,
out_of_stock
will return true, even if the product is not out of stock as a whole.out_of_stock_messagestring
Out of stock messages for display on the product page
Example: Out of stock
page_titlestring
price
ratinginteger
Rating for the product
related_products
reviews
shipping_messagesarray[object]
show_quantity_inputinteger
skustring
Default product variant when no options are selected.
stock_levelstring
Indicates the number of items available for sale. Visible only when inventory tracking is turned on.
tagsarray[object]
Keywords by which this product can also be identified.
titlestring
Displayed name of the product
upcstring
Optional UPC code for the product
urlstring
URL to the product detail page
videos
warrantystring
Optional warranty text set by the merchant
widthstring
The productʼs physical width measurement.
custom_fieldsarray[object]
product_results
{{product_results}}
productsarray[object]
ratinginteger
Example: 0
num_reviewsinteger
Example: 0
priceobject
tax_labelstring
Example: Tax
categoryarray[object]
products
The {{products}}
object available on pages with product cards like templates/pages/home.html
; contains new
, featured
, and top_sellers
.
newarray[]
featuredarray[]
Renders a list of all the featured products for the BigCommerce storefront.
top_sellersarray[]
Object to display a sidebar of top-selling products.
settings
Common settings shared across every BigCommerce storefront.
global
{{settings}}
object
Handlebars Expression: {{settings}}
account_creation_enabledboolean
Site-wide boolean value that indicates whether to allow customers to create accounts.
add_thisobject
Object that defines links for the AddThis social sharing component.
addressstring
Store’s complete physical address, as entered by merchant in the store profile.
base_urlstring
The normal shop URL.
blog_enabledboolean
Site-wide boolean value that indicates whether the blog is visible for this storefront.
bulk_discount_enabledboolean
Boolean that return true if bulk discount is enabled on products.
cdn_urlstring
client_ip_addressstring
IP address of the customer browsing the storefront.
country_codestring
The country code corresponding to the IP.
data_tag_enabledboolean
Site-wide boolean that indicates whether GAEE is enabled in a theme. For
{{settings.data_tag_enabled}}
to be true, the enhanced_ecommerce key must be present in config.json and a GAEE experiment must be enabled along with GA property value set in Advanced Settings > Analytics > GA in the store control panel.display_date_formatstring
Brief display format/pattern for dates, as configured in the control panelʼs Display Date Format field.
extended_display_date_formatstring
Extended display format/pattern for dates, as configured in the control panelʼs Extended Display Date Format field.
facebook_like_buttonobject
generalobject
gift_certificates_enabledboolean
Site-wide boolean value that indicates whether to enable the gift certificate system for this store.
is_eu_ip_addressboolean
A boolean value. Return true if the shoppers ip address is in the EU.
maintenanceobject
Object that manages information about the store when in maintenance (offline) mode.
measurementsobject
Collection of units-of-measure definitions, to be used when displaying product details:
moneyobject
List of child items that define the store’s default currency formatting.
newsletter_summarystring
Returns the newsletter summary.
password_requirementsobject
Collection of properties representing BigCommerce requirements for customer-account passwords:
payments_urlstring
Exposes the BigCommerce payments URL.
https://payments.bigcommerce.com.
phone_numberstring
The contact phone number for the store located in the stores profile.
privacy_cookieboolean
If enabled, a string containing merchant-customizable text for (European Union–required) cookie-setting notification; if disabled, a boolean with a value of false.
region_codestring
The ISO-3166-2 code is an international standard denomination for country subdivisions. The first part is the country's ISO 3166-1 alpha-2 code, and the second part is a string of up to three alphanumeric characters representing the country's subdivision (province or state). For example, Texas's ISO 3166-2 code is US-TX; therefore, the region code is TX.
requestobject
Object that contains details about the HTTP request.
returns_enabledinteger
Boolean that indicates whether the control-panel setting for the returns system is enabled.
rss_item_limitinteger
An integer that sets a limit on the number of RSS items to display.
secure_base_urlstring
The SSL-enabled, secure, shop URL.
secure_hoststring
Returns the SSL url for a store. Example:
https://www.bigcommerce.com
.shopper_consent_tracking_enabledboolean
show_newsletter_boxinteger
Site-wide boolean value that indicates whether to display a mailing-list invite to visitors.
show_newsletter_summaryinteger
Returns a 1 if the [newsletter summary](https://support.bigcommerce.com/s/article/Collecting-Newsletter-Subscriptions#newsletter is shown. Returns 0 if it is now shown. If show_newsletter_box is 0 then show_newsletter_summary will also be 0.
show_payment_methodsboolean
A boolean value. If true available payment methods on a store will be shown. If false they are hidden.
show_product_ratingboolean
Site-wide boolean value that indicates whether to display product ratings (in numeric or star format) to visitors.
show_product_reviewsboolean
Site-wide boolean value that indicates whether to display full-text product reviews to visitors.
show_wishlistboolean
Site-wide boolean value that indicates whether to allow customers to create wishlists.
store_dst_correctioninteger
Whether or not this time zone observes Daylight Saving Time (boolean), as set by the control panelʼs Enable DST Correction check box.
store_hashstring
Returns the store hash as a string.
store_logoobject
The store’s logo.
store_namestring
Name of the BigCommerce store.
store_time_zonestring
Storeʼs time zone, as selected in the control panelʼs Your Timezone dropdown list.
storefront_apiobject
tax_labelstring
Defines the Tax Label (VAT, Sales Tax, etc.) that a merchant can set in the control panel’s Settings > Tax page for display to customers.
theme_config_idstring
theme_session_idstring
theme_version_idstring
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}}
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}}
social_media
global
{{social_media}}
array of all social-media site links for the storefront.
Handlebars Expression: {{social_media}}
theme_settings
global
{{theme_settings}}
object
alert-backgroundColorstring
alert-colorstring
alert-color-altstring
applePay-buttonstring
blockquote-cite-font-colorstring
blog_sizestring
body-bgstring
body-fontstring
brand_sizestring
brandpage_products_per_pageinteger
button--default-borderColorstring
button--default-borderColorActivestring
button--default-borderColorHoverstring
button--default-colorstring
button--default-colorActivestring
button--default-colorHoverstring
button--disabled-backgroundColorstring
button--disabled-borderColorstring
button--disabled-colorstring
button--icon-svg-colorstring
button--primary-backgroundColorstring
button--primary-backgroundColorActivestring
button--primary-backgroundColorHoverstring
button--primary-colorstring
button--primary-colorActivestring
button--primary-colorHoverstring
card--alternate-backgroundColorstring
card--alternate-borderColorstring
card--alternate-color--hoverstring
card-figcaption-button-backgroundstring
card-figcaption-button-colorstring
card-title-colorstring
card-title-color-hoverstring
carousel-arrow-bgColorstring
carousel-arrow-borderColorstring
carousel-arrow-colorstring
carousel-bgColorstring
carousel-description-colorstring
carousel-dot-bgColorstring
carousel-dot-colorstring
carousel-dot-color-activestring
carousel-title-colorstring
categorypage_products_per_pageinteger
checkRadio-backgroundColorstring
checkRadio-borderColorstring
checkRadio-colorstring
color-blackstring
color-errorstring
color-errorLightstring
color-greystring
color-greyDarkstring
color-greyDarkerstring
color-greyDarkeststring
color-greyLightstring
color-greyLighterstring
color-greyLighteststring
color-greyMediumstring
color-infostring
color-infoLightstring
color-primarystring
color-primaryDarkstring
color-primaryDarkerstring
color-primaryLightstring
color-secondarystring
color-secondaryDarkstring
color-secondaryDarkerstring
color-successstring
color-successLightstring
color-textBasestring
color-textBase--activestring
color-textBase--hoverstring
color-textHeadingstring
color-textLinkstring
color-textLink--activestring
color-textLink--hoverstring
color-textSecondarystring
color-textSecondary--activestring
color-textSecondary--hoverstring
color-warningstring
color-warningLightstring
color-whitestring
color-whitesBasestring
color_badge_product_sale_badgesstring
color_hover_product_sale_badgesstring
color_text_product_sale_badgesstring
container-border-global-color-basestring
container-fill-basestring
container-fill-darkstring
default_image_brandstring
default_image_gift_certificatestring
default_image_productstring
dropdown--quickSearch-backgroundColorstring
dropdown--wishList-backgroundColorstring
fontSize-h1integer
fontSize-h2integer
fontSize-h3integer
fontSize-h4integer
fontSize-h5integer
fontSize-h6integer
fontSize-rootinteger
footer-backgroundColorstring
form-label-font-colorstring
gallery_sizestring
geotrust_ssl_common_namestring
geotrust_ssl_seal_sizestring
header-backgroundColorstring
headings-fontstring
hide_blog_page_headingboolean
hide_breadcrumbsboolean
hide_category_page_headingboolean
hide_contact_us_page_headingboolean
hide_content_navigationboolean
hide_page_headingboolean
homepage_blog_posts_countinteger
homepage_featured_products_column_countinteger
homepage_featured_products_countinteger
homepage_new_products_column_countinteger
homepage_new_products_countinteger
homepage_show_carouselboolean
homepage_show_carousel_arrowsboolean
homepage_stretch_carousel_imagesboolean
homepage_top_products_column_countinteger
homepage_top_products_countinteger
icon-colorstring
icon-color-hoverstring
icon-ratingEmptystring
icon-ratingFullstring
input-bg-colorstring
input-border-colorstring
input-border-color-activestring
input-disabled-bgstring
input-font-colorstring
label-backgroundColorstring
label-colorstring
loadingOverlay-backgroundColorstring
logo-positionstring
logo_fontSizeinteger
logo_sizestring
navPages-colorstring
navPages-color-hoverstring
navPages-subMenu-backgroundColorstring
navPages-subMenu-separatorColorstring
navUser-colorstring
navUser-color-hoverstring
navUser-dropdown-backgroundColorstring
navUser-dropdown-borderColorstring
navUser-indicator-backgroundColorstring
navigation_designstring
optimizedCheckout-backgroundImagestring
optimizedCheckout-backgroundImage-sizestring
optimizedCheckout-body-backgroundColorstring
optimizedCheckout-buttonPrimary-backgroundColorstring
optimizedCheckout-buttonPrimary-backgroundColorActivestring
optimizedCheckout-buttonPrimary-backgroundColorDisabledstring
optimizedCheckout-buttonPrimary-backgroundColorHoverstring
optimizedCheckout-buttonPrimary-borderColorstring
optimizedCheckout-buttonPrimary-borderColorActivestring
optimizedCheckout-buttonPrimary-borderColorDisabledstring
optimizedCheckout-buttonPrimary-borderColorHoverstring
optimizedCheckout-buttonPrimary-colorstring
optimizedCheckout-buttonPrimary-colorActivestring
optimizedCheckout-buttonPrimary-colorDisabledstring
optimizedCheckout-buttonPrimary-colorHoverstring
optimizedCheckout-buttonPrimary-fontstring
optimizedCheckout-buttonSecondary-backgroundColorstring
optimizedCheckout-buttonSecondary-backgroundColorActivestring
optimizedCheckout-buttonSecondary-backgroundColorHoverstring
optimizedCheckout-buttonSecondary-borderColorstring
optimizedCheckout-buttonSecondary-borderColorActivestring
optimizedCheckout-buttonSecondary-borderColorHoverstring
optimizedCheckout-buttonSecondary-colorstring
optimizedCheckout-buttonSecondary-colorActivestring
optimizedCheckout-buttonSecondary-colorHoverstring
optimizedCheckout-buttonSecondary-fontstring
optimizedCheckout-colorFocusstring
optimizedCheckout-contentPrimary-colorstring
optimizedCheckout-contentPrimary-fontstring
optimizedCheckout-contentSecondary-colorstring
optimizedCheckout-contentSecondary-fontstring
optimizedCheckout-discountBanner-backgroundColorstring
optimizedCheckout-discountBanner-iconColorstring
optimizedCheckout-discountBanner-textColorstring
optimizedCheckout-form-textColorstring
optimizedCheckout-formChecklist-backgroundColorstring
optimizedCheckout-formChecklist-backgroundColorSelectedstring
optimizedCheckout-formChecklist-borderColorstring
optimizedCheckout-formChecklist-colorstring
optimizedCheckout-formField-backgroundColorstring
optimizedCheckout-formField-borderColorstring
optimizedCheckout-formField-errorColorstring
optimizedCheckout-formField-inputControlColorstring
optimizedCheckout-formField-placeholderColorstring
optimizedCheckout-formField-shadowColorstring
optimizedCheckout-formField-textColorstring
optimizedCheckout-header-backgroundColorstring
optimizedCheckout-header-borderColorstring
optimizedCheckout-header-textColorstring
optimizedCheckout-headingPrimary-colorstring
optimizedCheckout-headingPrimary-fontstring
optimizedCheckout-headingSecondary-colorstring
optimizedCheckout-headingSecondary-fontstring
optimizedCheckout-link-colorstring
optimizedCheckout-link-fontstring
optimizedCheckout-link-hoverColorstring
optimizedCheckout-loadingToaster-backgroundColorstring
optimizedCheckout-loadingToaster-textColorstring
optimizedCheckout-logostring
optimizedCheckout-logo-positionstring
optimizedCheckout-logo-sizestring
optimizedCheckout-orderSummary-backgroundColorstring
optimizedCheckout-orderSummary-borderColorstring
optimizedCheckout-show-backgroundImageboolean
optimizedCheckout-show-logostring
optimizedCheckout-step-backgroundColorstring
optimizedCheckout-step-borderColorstring
optimizedCheckout-step-textColorstring
overlay-backgroundColorstring
pace-progress-backgroundColorstring
paymentbuttons-paypal-colorstring
paymentbuttons-paypal-fundingiconsboolean
paymentbuttons-paypal-labelstring
paymentbuttons-paypal-layoutstring
paymentbuttons-paypal-shapestring
paymentbuttons-paypal-sizestring
paymentbuttons-paypal-taglineboolean
pdp-custom-fields-tab-labelstring
pdp-non-sale-price-labelstring
pdp-price-labelstring
pdp-retail-price-labelstring
pdp-sale-price-labelstring
price_rangesboolean
product_list_display_modestring
product_sale_badgesstring
product_sizestring
productgallery_sizestring
productpage_related_products_countinteger
productpage_reviews_countinteger
productpage_similar_by_views_countinteger
productpage_videos_countinteger
productthumb_sizestring
productview_thumb_sizestring
restrict_to_loginboolean
searchpage_products_per_pageinteger
select-arrow-colorstring
select-bg-colorstring
shop_by_brand_show_footerboolean
shop_by_price_visibilityboolean
show_accept_amexboolean
show_accept_discoverboolean
show_accept_mastercardboolean
show_accept_paypalboolean
show_accept_visaboolean
show_copyright_footerboolean
show_custom_fields_tabsboolean
show_powered_byboolean
show_product_details_tabsboolean
show_product_dimensionsboolean
show_product_quantity_boxboolean
show_product_quick_viewboolean
show_product_reviewsboolean
show_product_weightboolean
social_icon_placement_bottomstring
social_icon_placement_topboolean
spinner-borderColor-darkstring
spinner-borderColor-lightstring
storeName-colorstring
supported_card_type_iconsarray[string]
swatch_option_sizestring
thumb_sizestring
zoom_sizestring
urls
global
{{urls}}
object containing a collection of storefront pages and their sub-pages
accountobject
authobject
brandsstring
cartstring
checkoutobject
comparestring
contact_us_submitstring
gift_certificateobject
homestring
productobject
rssobject
searchstring
sitemapstring
subscribeobject
vault
{{vault}}
object available to templates/pages/account/payment-methods.html
.
Handlebars Expression: {{vault}}
access_tokenstring
Required to submit add payment method form; otherwise, submission will fail with
401
Unauthorized.Example: {{token}}
expires_atnumber
Expiration Date in Unix Timestamp.
Example: 1616614163
wishlist
Wishlist information for a specific wishlist. (Called on the default templates/pages/account/wishlist-details.html
template and the templates/components/account/wishlist-item-list.html
partial.)
Handlebars Expression: {{wishlist}}
idnumber
Unique system ID for the wishlist.
is_editableboolean
is_publicboolean
Boolean value indicating whether the wishlist is publicly available.
itemsarray[object]
namestring
Customer-defined name of the wishlist.
paginationobject
share_urlstring
URL used to share the wishlist.
tokenstring
Unique public token for the wishlist.