BigCommerce
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

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}}

  • config
    array[object]

  • faceted_search_enabled
    boolean

    Boolean that defines whether product-filtering search is enabled for the store.

  • facets
    array[object]

    A list of all possible search filters for this brand.

  • image

  • meta
    array[object]

  • name
    string

    Name of the brand

  • products
    array[]

    An array of product card models.

  • search_error
    boolean

  • selected
    object

    An array of selected facets.

  • show_compare
    boolean

    Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons.

  • state
    array[object]

  • url
    string

    URL of the brand page

brand_results

{{brand_results}} array

  • url
    string

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

  • name
    string

    Example: Test brand

brands

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

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}}

  • 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

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}}

  • config
    array[object]

  • description
    string

    Merchant-defined description of the category.

  • detail_messages
    array[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_enabled
    boolean

    Boolean that defines whether product-filtering search is enabled for the store.

  • facets
    array[object]

    Available search facets.

  • id
    integer

    Unique ID for the category.

  • image

  • meta
    array[object]

  • name
    string

    Merchant-defined category name.

  • products
    array[]

  • selected
    array[object]

    Selected search facets.

  • shop_by_price
    array[object]

    Exposes price- and currency-related properties in both raw numeric, and formatted string, formats.

  • show_compare
    integer

    Boolean that defines whether to show controls for product comparison

  • state
    array[object]

  • subcategories
    array[object]

    List of any child categories.

  • total_products
    integer

    Count of the number of products in the category.

  • url
    string

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}}

content_results

{{content_results}} array

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_url
    string

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}} 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_id
    number

    ID of this customerʼs group.

  • customer_group_name
    string

    Name of this customerʼs group.

  • edit_stored_instrument
    string

  • email
    string

    Customer’s email address.

  • id
    integer

    Customerʼs ID.

  • name
    string

    Customerʼs name.

  • num_new_messages
    integer

    Number of unread messages for this customer.

  • num_wishlists
    string

    Number of wishlists for this customer.

  • orders

  • payment_methods

  • phone
    string

    Customerʼs phone number.

  • recently_viewed_products
    array[]

  • returns

  • shipping_address
    object

    Shipping address used for the order.

  • shipping_addresses

  • store_credit
    object

    Customerʼs store credit.

  • wishlists

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}}

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}} object available to pages and components with forms

Handlebars Expression: {{forms.edit_account}}

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

The {{order}} object available to templates and components with order context.

Handlebars Expression: {{order}}

  • billing_address
    object

    Billing address used for the order.

  • comments
    string

  • date
    string

    Date of the order

  • has_multiple_shipping_addresses
    boolean

  • id
    integer

    Unique, system-generated ID

  • invoice_url
    string

  • is_complete
    boolean

    Boolean indicating that the order has been completed

  • is_digital
    string

  • items
    array[object]

    List of items for the order.

  • last_updated
    string

  • order_instructions
    string

  • payment_method
    string

    Customer’s payment method for this order (payment gateway)

  • reorder_url
    string

    URL to place reorders for items in this order.

  • return_url
    string

  • returns_enabled
    integer

    Boolean that indicates whether merchant allows products from the order to be returned.

  • shipping_address
    object

    Shipping address used for the order.

  • shipping_address_count
    string

    Number of shipping addresses the customer has specified for this order.

  • shipping_method
    string

  • status
    string

    Order status code

  • status_messages
    array[object]

    Status message associated with the status code for the order

  • status_text
    string

    Status text associated with the status code for the order.

  • total
    object

    Price object that defines the order’s total value

  • total_rows
    array[object]

    A list of “total” rows containing total pricing information

  • pickup_address
    object

  • brand
    string

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

{{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}}

  • AddThisServiceButtonMeta
    string

  • add_this
    array[object]

  • add_to_wishlist_url
    string

    URL to add the product to the customer's wishlist

  • availability
    string

  • brand
    array[object]

    The company, product line, or trademark associated with the product.

  • bulk_discount_rates
    array[object]

    List of discount rates for the current product

  • can_purchase
    boolean

    Boolean that indicates whether the product is available for purchase

  • cart_url
    string

    URL to the customer's shopping cart

  • category
    array[string]

  • condition
    string

    Product condition

  • customizations
    array[object]

    Product customizations (for example, a T-shirt size); these correspond to configurable fields and numeric-text product options in the BigCommerce control panel

  • depth
    string

    The product's physical depth measurement.

  • description
    string

    (HTML) description of the product

  • detail_messages
    string

    Status messages for display at the top of the product page

  • gift_wrapping_available
    boolean

    Whether or not gift wrapping is enabled

  • gtin
    string

    Global Trade Item Number. An identifier for trade items that is incorporated into several product identification standards, such as ISBN, UPC, and EAN.

  • height
    string

    The product's physical height measurement.

  • id
    string

    Unique ID for the product

  • images
    array[object]

    List of all images for this product, in Stencil image format (as configured in config.json; used with the getImage Handlebars helper)

  • main_image
    object

    Primary image to display when the product details page loads

  • max_purchase_quantity
    integer

    Maximum quantity that can be purchased at once

  • meta_description
    string

  • meta_keywords
    string

    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_quantity
    integer

    Minimum quantity that can be purchased at once

  • mpn
    string

    Manufacturer Part Number. It is used to reference and identify a product.

  • num_reviews
    integer

    Number of reviews the product has

  • options

  • out_of_stock
    boolean

    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_message
    string

    Out of stock messages for display on the product page

    Example: Out of stock

  • page_title
    string

  • price

  • rating
    integer

    Rating for the product

  • related_products

  • reviews

  • shipping
    object

  • shipping_messages
    array[object]

  • show_quantity_input
    integer

  • sku
    string

    Default product variant when no options are selected.

  • stock_level
    string

    Indicates the number of items available for sale. Visible only when inventory tracking is turned on.

  • tags
    array[object]

    Keywords by which this product can also be identified.

  • title
    string

    Displayed name of the product

  • upc
    string

    Optional UPC code for the product

  • url
    string

    URL to the product detail page

  • videos

  • warranty
    string

    Optional warranty text set by the merchant

  • width
    string

    The product's physical width measurement.

  • custom_fields
    array[object]

product_results

{{product_results}}

  • products
    array[object]

  • rating
    integer

    Example: 0

  • num_reviews
    integer

    Example: 0

  • price
    object

  • tax_label
    string

    Example: Tax

  • category
    array[object]

products

The {{products}} object available on pages with product cards like templates/pages/home.html; contains new, featured, and top_sellers.

  • new
    array[]

  • featured
    array[]

    Renders a list of all the featured products for the BigCommerce storefront.

  • top_sellers
    array[]

    Object to display a sidebar of top-selling products.

remote_api_scripts

settings

Common settings shared across every BigCommerce storefront.

global {{settings}} object

Handlebars Expression: {{settings}}

  • account_creation_enabled
    boolean

    Site-wide boolean value that indicates whether to allow customers to create accounts.

  • add_this
    object

    Object that defines links for the AddThis social sharing component.

  • address
    string

    Store’s complete physical address, as entered by merchant in the store profile.

  • base_url
    string

    The normal shop URL.

  • blog_enabled
    boolean

    Site-wide boolean value that indicates whether the blog is visible for this storefront.

  • bulk_discount_enabled
    boolean

    Boolean that return true if bulk discount is enabled on products.

  • cdn_url
    string

  • client_ip_address
    string

    IP address of the customer browsing the storefront.

  • country_code
    string

    The country code corresponding to the IP.

  • data_tag_enabled
    boolean

    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_format
    string

    Brief display format/pattern for dates, as configured in the control panelʼs Display Date Format field.

  • extended_display_date_format
    string

    Extended display format/pattern for dates, as configured in the control panelʼs Extended Display Date Format field.

  • facebook_like_button
    object

  • general
    object

  • gift_certificates_enabled
    boolean

    Site-wide boolean value that indicates whether to enable the gift certificate system for this store.

  • is_eu_ip_address
    boolean

    A boolean value. Return true if the shoppers ip address is in the EU.

  • maintenance
    object

    Object that manages information about the store when in maintenance (offline) mode.

  • measurements
    object

    Collection of units-of-measure definitions, to be used when displaying product details:

  • money
    object

    List of child items that define the store’s default currency formatting.

  • newsletter_summary
    string

    Returns the newsletter summary.

  • password_requirements
    object

    Collection of properties representing BigCommerce requirements for customer-account passwords:

  • payments_url
    string

    Exposes the BigCommerce payments URL. https://payments.bigcommerce.com.

  • phone_number
    string

    The contact phone number for the store located in the stores profile.

  • privacy_cookie
    boolean

    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_code
    string

    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.

  • request
    object

    Object that contains details about the HTTP request.

  • returns_enabled
    integer

    Boolean that indicates whether the control-panel setting for the returns system is enabled.

  • rss_item_limit
    integer

    An integer that sets a limit on the number of RSS items to display.

  • secure_base_url
    string

    The SSL-enabled, secure, shop URL.

  • secure_host
    string

    Returns the SSL url for a store. Example: https://www.bigcommerce.com.

  • shopper_consent_tracking_enabled
    boolean

  • show_newsletter_box
    integer

    Site-wide boolean value that indicates whether to display a mailing-list invite to visitors.

  • show_newsletter_summary
    integer

    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_methods
    boolean

    A boolean value. If true available payment methods on a store will be shown. If false they are hidden.

  • show_product_rating
    boolean

    Site-wide boolean value that indicates whether to display product ratings (in numeric or star format) to visitors.

  • show_product_reviews
    boolean

    Site-wide boolean value that indicates whether to display full-text product reviews to visitors.

  • show_wishlist
    boolean

    Site-wide boolean value that indicates whether to allow customers to create wishlists.

  • store_dst_correction
    integer

    Whether or not this time zone observes Daylight Saving Time (boolean), as set by the control panelʼs Enable DST Correction check box.

  • store_hash
    string

    Returns the store hash as a string.

  • store_logo
    object

    The store’s logo.

  • store_name
    string

    Name of the BigCommerce store.

  • store_time_zone
    string

    Storeʼs time zone, as selected in the control panelʼs Your Timezone dropdown list.

  • storefront_api
    object

  • tax_label
    string

    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_id
    string

  • theme_session_id
    string

  • theme_version_id
    string

shipments

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

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}}

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}}

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
    string

  • optimizedCheckout-logo-position
    string

  • optimizedCheckout-logo-size
    string

  • optimizedCheckout-orderSummary-backgroundColor
    string

  • optimizedCheckout-orderSummary-borderColor
    string

  • optimizedCheckout-show-backgroundImage
    boolean

  • optimizedCheckout-show-logo
    string

  • 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

  • restrict_to_login
    boolean

  • 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

  • social_icon_placement_bottom
    string

  • social_icon_placement_top
    boolean

  • spinner-borderColor-dark
    string

  • spinner-borderColor-light
    string

  • 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

  • account
    object

  • 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

  • subscribe
    object

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

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}}

  • id
    number

    Unique system ID for the wishlist.

  • is_editable
    boolean

  • is_public
    boolean

    Boolean value indicating whether the wishlist is publicly available.

  • items
    array[object]

  • name
    string

    Customer-defined name of the wishlist.

  • pagination
    object

  • share_url
    string

    URL used to share the wishlist.

  • token
    string

    Unique public token for the wishlist.

Did you find what you were looking for?