Schemas

Stencil theme object schemas describe the data available to Handlebars templates on BigCommerce storefronts. Each schema documents the properties of a global or page-specific object.

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.

Properties:

• bottom array — Array of HTML content/strings, for custom bottom-banner content; banners are populated from the BigCommerce control panel
• top array — 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}}

Template blog object

{{blog}} object available to blog and blog post templates and components

Properties:

• description string — Blog description.
• name string — Blog name.
• posts object (external ref)
• tag null — The blog’s tag.
• url string — URL to the blog page.

Global blog object

global {{blog}} object

Properties:

• name string — Blog name.
• recent_posts object (external ref)
• url string — URL to the blog page.

brand

The brand object for the page calling the object.

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

Handlebars Expression: {{brand}}

Properties:

• config array
• faceted_search_enabled boolean — Boolean that defines whether product-filtering search is enabled for the store.
• facets array — A list of all possible search filters for this brand.
• image object (external ref)
• meta array
• name string — Name of the brand
• products array — An array of product card models.
• search_error boolean
• selected object — An array of selected facets.
  • items array
  • remove_all_url string
• show_compare boolean — Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons.
• state array
• url string — URL of the brand page. Only letters, numbers, dots (.), dashes (-), underscores (_), and forward slashes (/) are allowed. Must be 1-1024 characters, consisting of segments divided by ”/”. Each segment must be 1-256 characters.

brand_results

{{brand_results}} array

Properties:

• url string
• name string

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

Properties:

• slides array — Object containing properties for each slide in the slideshow.
  • alt_text string — Alt text for the image.
  • button_text string — Text displayed on a call-to-action button defined by the merchant.
  • button_text_color string — Color of the button.
  • heading string — Heading message defined by the merchant.
  • heading_color string — Color of the heading text.
  • image string — Path to the image file used on this slide.
  • image_height string
  • image_width string
  • stencil_image object
    • alt string
    • data string
    • height integer
    • width integer
  • text string — Subheading defined by the merchant.
  • text_color string — Color of the subheading text
  • url string — URL to which the image will link.
• 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}}

Properties:

• additional_checkout_buttons array — Generates checkout buttons for third-party payments (PayPal, Google Checkout, etc.)
• coupons array — List of coupons applied to the cart; default sorting is by coupon ID, from lowest to highest.
  • id number
  • code string
  • displayName string
  • couponType string
  • discountedAmount number
• discount object — Discount being applied to the cart in the current session.
  • formatted string
  • value integer
• gift_certificates array — List of gift certificates applied to the cart.
  • id string
  • name string
  • theme string
  • amount number
  • taxable boolean
  • sender array
    • name string
    • email string
  • recipient array
    • name string
    • email string
  • message string
• gift_wrapping_cost object — Price object that defines the cost associated with adding gift wrapping to the items in the cart.
  • currency string
  • formatted string
  • value integer
• 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.
  • currency string
  • formatted string
  • value number
• items array
  • availability string
  • base_price object
    • currency string
    • formatted string
    • value number
  • brand object
    • name string
  • can_modify boolean
  • category_names array
  • configurable_fields array
  • custom_fields array
    • id integer
    • name string
    • value string
  • id string — Unique ID of the coupon.
  • image object
    • alt string — Corresponding text to display for missing images, accessible screen readers, etc.
    • data string — Internal URL to the image.
  • max_purchase_quantity integer
  • min_purchase_quantity integer
  • name string
  • options array
    • id string
    • name string
    • value string
    • is_file boolean
  • price object
    • currency string
    • formatted string
    • value number
  • price_discounted object
    • currency string
    • formatted string
    • value number
  • product_id integer
  • quantity integer — Total number of items in the cart.
  • release_date string
  • remove_url string — URL to remove gift certificate from the cart.
  • rrp object — Price object that defines the cart item’s list price (MSRP); can be used to display struck-out list prices.
    • currency string
    • formatted string
    • value integer
  • sale_price object
    • currency string
    • formatted string
    • value number
  • show_gift_wrapping boolean — Boolean indicating whether the wrapping options are shown.
  • sku string
  • total object
    • currency string
    • formatted string
    • value number
  • total_discounted object
    • currency string
    • formatted string
    • value number
  • type string
  • url string
  • variant_id integer
• 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.
  • countries array — Countries available to ship to.
    • currency object
      • code string
      • name string
      • symbol string
    • id integer
    • iso2 string
    • iso3 string
    • name string
    • selected boolean
  • selected_city string — The city/town that the customer selected for the shipping estimate.
  • selected_country string
  • selected_state string — The state/province/region that the customer selected for the shipping estimate.
  • selected_zip string — The ZIP/postal code that the customer selected for the shipping estimate.
  • show_estimator boolean — Boolean indicating whether the merchant wants to show the shipping estimator to customers.
  • states array — List of states/provinces/regions for the country.
    • id string
    • name string
• 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
  • message string
  • type number
• 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.
  • currency string
  • formatted string
  • value number
• taxes array — List of all applicable taxes for the cart.
  • cost object — Price object that defines the cost of the applied tax.
    • currency string
    • formatted string
    • value number
  • included boolean — Boolean that indicates whether taxes are included in the total price for the cart’s contents.
  • name string

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

Properties:

• config array
• description string — Merchant-defined description of the category.
• detail_messages array — 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 — Available search facets.
• id integer — Unique ID for the category.
• image object (external ref)
• meta array
• name string — Merchant-defined category name.
• products array
• selected array — Selected search facets.
• shop_by_price array — Exposes price- and currency-related properties in both raw numeric, and formatted string, formats. It will return empty for stores with faceted search enabled who are not explicitly requesting this information in their front matter.
  • high object — Price object that defines the maximum price boundary.
    • currency string
    • formatted string
    • value integer
  • low object — Price object that defines the minimum price boundary
    • currency string
    • formatted string
    • value integer
  • selected boolean — Price object that defines the currently selected price range.
  • url string — URL of price-filtered product results for this category.
• show_compare integer — Boolean that defines whether to show controls for product comparison
• state array
• subcategories array — List of any child categories.
  • description string — Merchant-defined description of the subcategory.
  • id integer — Unique ID for the subcategory.
  • image null — Image representing this subcategory, in Stencil image format.
  • name string — Name of the subcategory
  • product_count integer — Number of products in the subcategory. (Counts at the current level only – not recursive to deeper levels.)
  • url string — URL to the subcategory.
• total_products integer — Count of the number of products in the category.
• url string

category_results

{{category_results}} array

Properties:

• url string
• name string

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

Properties:

• order_confirmation_content string — Default content from checkout template.
• checkout_head string — Default content from checkout <head>.
• order object — {{checkout.order}} object available to order confirmation templates and components.
  • id number — The id of the order. To access checkout.order.id from order-confirmation.html, use Script Manager or the Stencil themeʼs page context to assign the value of checkout.order.id to a variable. For more information, see the example in Using the Fetch API.
• header_image string — The image src of the header.
• id string — the cart and checkout id

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

Properties:

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

Properties:

• 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 — List of all the currencies supported for this storefront.
  • is_active boolean — Boolean that indicates whether this currency is active for use in the storefront
  • switch_url string — The URL to invoke a switch to this currency.
  • id string — ID of the currency.
  • name string — Name of the currency.
  • flag string — Country flag used to visually represent the currency.

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

Properties:

• addresses object (external ref)
• 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 object (external ref)
• payment_methods object (external ref)
• phone string — Customer’s phone number.
• recently_viewed_products array
• returns object (external ref)
• shipping_address object — Shipping address used for the order.
  • address1 string — Customer’s shipping address, first line.
  • address2 string — Customer’s shipping address, second line.
  • city string — Customer’s shipping city.
  • company string — Customer’s shipping company name.
  • country string — Customer’s shipping country.
  • country_id string — ID for customer’s shipping country.
  • destination string — Type of delivery destination: residential or business/commercial.
  • first_name string — Customer’s shipping (first) name.
  • form_session_id string — Used for custom shipping forms.
  • id string — Unique, system-generated ID.
  • last_name string — Customer’s shipping (last) name.
  • last_used string — Timestamp when this address was last used as a shipping address.
  • phone string — Customer’s shipping phone number.
  • state string — Customer’s shipping state.
  • state_id string — ID for customer’s shipping state/province/region.
  • zip string — Customer’s shipping postal code.
• shipping_addresses object (external ref)
• store_credit object — Customer’s store credit.
  • currency string
  • formatted string
  • value number
• wishlists object (external ref)

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

Properties:

• facets string — List of all search facets available.
• selected array — Container for the selected search facets (selected facets contain properties below)
  • remove_all_url string — URL to remove all selected search restrictions.
  • items string — Currently enabled search facets

footer

The footer content for each storefront page.

global {{footer}} object

Handlebars Expression: {{footer}}

Properties:

• 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

Properties:

• captcha_url string
• company boolean
• name boolean
• order boolean
• page_id string
• phone boolean
• recaptcha array
  • enabled number
  • markup string
  • public_key string
• rma boolean
• text string

head

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

Handlebars Expression: {{head}}

Properties:

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

Properties:

• billing_address object — Billing address used for the order.
  • address_lines array — Customer’s billing address
  • city string — Customer’s billing city
  • company string — Customer’s billing company name
  • country string — Customer billing country
  • email string — Customer’s billing email
  • full_name string — Customer’s billing name
  • phone string — Customer billing phone number
  • state string — Customer’s billing state
  • zip string — Customer billing ZIP
• 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 — List of items for the order.
  • gift_wrapping_name string
  • image object (external ref)
  • name string — Product Name
  • options array
    • name string
    • value string
  • order_product_id string — Product ID
  • price object
    • currency string
    • formatted string
    • value integer
  • quantity integer — Quantity Ordered
  • refunded boolean — Price object that defines the value of this product that has been refunded.
  • refunded_qty integer
  • reorder_message string — An error message to be displayed when the customer attempts to reorder items that can’t be reordered.
  • return_url string
  • shipping_rows array — Array of shipping addresses, for each item in the order
  • show_reorder boolean — Boolean indicating whether the customer should see a button for reordering items on the Account Order Details page.
  • sku string
  • total object — Price object that defines the order’s total value
    • currency string
    • formatted string
    • value integer
  • type string
• 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.
  • address_lines array — Customer’s shipping address
  • city string — Customer’s shipping city
  • company string — Customer’s shipping company name
  • country string — Customer’s shipping country
  • email string — Customer’s email
  • full_name string — Customer’s shipping name
  • phone string — Customer’s shipping phone number
  • state string — Customer’s shipping state
  • zip string — Customer’s shipping zip
• 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 — 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
  • currency string
  • formatted string
  • value number
• total_rows array — A list of “total” rows containing total pricing information
  • label string — The label of the total row (Subtotal, Tax, Grand Total, etc.).
  • value object — Value that customer selected for the option.
    • currency string
    • formatted string
    • value integer | number
• pickup_address object
  • location object
    • name string
    • code string
    • address_line_1 string
    • address_line_2 string
    • city string
    • state string
    • postal_code string
    • country_alpha2 string
    • email string
    • phone string
  • collection_time_description string
  • collection_instructions string
  • pickup_method_display_name string
  • pickup_method_id number
• brand string

page

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

Handlebars Expression: {{page}}

Properties:

• breadcrumbs array — Present if page has ancestors.
• content string — HTML content of the page
• id integer
• sub_pages array — Array of child pages
  • title string
  • url string
• 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
• 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}}

Properties:

• URL string — URL of the page.
• children array — List of child pages for this page.
  • URL string — URL of the child page.
  • name string — Name of the child 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}}

price

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

Properties:

• AddThisServiceButtonMeta string
• add_this array
  • annotation string
  • service string
• add_to_wishlist_url string — URL to add the product to the customer’s wishlist
• availability string
• brand array — The company, product line, or trademark associated with the product.
  • name string — The name of the company, product line, or trademark.
  • url string — The store’s internal page with all the products from that brand.
• bulk_discount_rates array — List of discount rates for the current product
  • type string
  • min integer
  • max integer
  • discount object
    • formatted string
    • value integer
• 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
• condition string — Product condition
• customizations array — Product customizations (for example, a T-shirt size); these correspond to configurable fields and numeric-text product options in the BigCommerce control panel
• custom_fields array
  • id integer
  • name string
  • value string
• 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 integer — Unique ID for the product
• images array — List of all images for this product, in Stencil image format (as configured in config.json; used with the getImage Handlebars helper)
  • alt string
  • data string
• main_image object — Primary image to display when the product details page loads
  • alt string
  • data string
• 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 object (external ref)
• 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
• page_title string
• price object (external ref)
• rating integer — Rating for the product
• related_products object (external ref)
• reviews object (external ref)
• shipping object
  • calculated boolean
  • price object
    • formatted string
    • value number
    • currency string
  • free boolean
  • fixed boolean
• shipping_messages array
• 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 — 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 object (external ref)
• warranty string — Optional warranty text set by the merchant
• width string — The product’s physical width measurement.

product_results

{{product_results}}

Properties:

• products array
  • id integer
  • sku string
  • name string
  • url string
  • brand object
    • name null
  • availability string
  • summary string
  • image object
    • data string
    • alt string
  • qty_in_cart integer
  • pre-order boolean — false
  • has_options boolean — true
  • show_cart_action boolean — true
  • stock_level null
  • low_stock_level null
  • weight object
    • formatted string — 12.00 Ounces
    • value integer
  • demo boolean — false
  • date_added string
  • add_to_wishlist_url string
  • custom_fields null
  • images object
    • data string
    • alt string
• rating integer
• num_reviews integer
• price object
  • without_tax object
    • formatted number
    • value integer
    • currency string
• tax_label string
• category array
  • Bundle Inventory Tracker string
  • Bundle Inventory Tracker/Bundles string

products

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

Properties:

• 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

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

settings

Common settings shared across every BigCommerce storefront.

global {{settings}} object

Handlebars Expression: {{settings}}

Properties:

• 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.
  • buttons array — Array of buttons to display for AddThis social sharing {{#each settings.add_this.buttons}}{{service}}{{/each}} {{#each settings.add_this.buttons}}{{annotations}}{{/each}}.
    • annotation string — String containing HTML attributes associated with this button.
    • service string — String containing the name of this buttonʼs social-media service (facebook, email, print, twitter, linkedin, google, etc.)
• 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 — The IP address of the customer browsing the storefront. An alternative to this deprecated field is using ipify API.
• 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
  • enabled boolean
  • href string
  • verb string
• general object
  • fastCart boolean
  • storeId integer
• 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 shopper’s IP address is in the EU. Alternatives to this deprecated field are solutions like the IP Geolocation API, IP Geolocation API Package, and others. While those solutions are not free, they offer a generous free tier, better data quality, and more data points than just the region.
• maintenance object — Object that manages information about the store when in maintenance (offline) mode.
  • header null — If store is in maintenance mode, string containing header text for the Down for Maintenance window displayed to visitors; otherwise, null.
  • message null — If store is in maintenance mode, string containing merchant-customizable body text (and optionally, HTML) for the Down for Maintenance window displayed to visitors; otherwise, null.
  • notice null — If store is in maintenance mode, one of three strings identifying the storeʼs status, and generating a corresponding text notice to merchants about how to proceed: AdminPrelaunchNotice for preview stores, AdminMaintenanceNotice for active stores taken down for maintenance, or AdminHibernationModeNotice for deactivated stores; otherwise, null.
  • password null
  • securePath string
• measurements object — Collection of units-of-measure definitions, to be used when displaying product details:
  • length string — Units of measure for product length
  • weight string — Units of measure for product weight
• money object — List of child items that define the store’s default currency formatting.
  • currency_location string — Whether currency symbol appears at left or right of the quantity
  • currency_token string — Symbol for the currency
  • decimal_places integer — Number of decimal places to display
  • decimal_token string — Symbol for decimal separator
  • thousands_token string — Symbol for thousands separator
• newsletter_summary string — Returns the newsletter summary.
• password_requirements object — Collection of properties representing BigCommerce requirements for customer-account passwords:
  • alpha string — Regular expression representing required/acceptable alphabetic characters.
  • error string — String that passes a standard error message for noncompliant password.
  • minlength integer — Integer representing minimum acceptable password length.
  • numeric string — Regular expression representing required/acceptable numeric characters.
• 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. The value is approximate as it is based on the IP address geolocation. Alternatives to this deprecated field are solutions like https://ipinfo.io/products/ip-geolocation-api and others. While those solutions are not free, they offer a generous free tier, better data quality, and more data points than just the region.
• request object — Object that contains details about the HTTP request.
  • absolute_path string — The absolute URL requested. Never use request.path in the actual body of the page.
  • host string — Hostname of the request.
  • is_crawler boolean — Renders true if the user agent is a known crawler; otherwise, false. NOTE: Serving different versions of the page to crawlers is considered detrimental to SEO cloaking and is rarely needed. An alternative to this field is using a front-end bot detection like isbot.
  • locale string — The browserʼs locale. Allows for varying experience based on shopper locale.
  • origin string — Origin of the request.
  • referer boolean — Refer of the request.
  • user_agent string — User agent string of the request. An alternative is using JavaScript detection (Navigator: userAgent property).
• 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.
  • title string — Title for the logo. Configure the text in the control panel under Storefront Design Design Options Logo.
  • image object (external ref)
• 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
  • token string
• 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

Properties:

• 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
• swatch_option_size string
• thumb_size string
• zoom_size string

urls

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

Properties:

• account object
  • add_address string
  • addresses string
  • details string
  • inbox string
  • index string
  • orders object
    • all string
    • completed string
    • save_new_return string
  • payment_methods object
    • all string
  • recent_items string
  • returns string
  • send_message string
  • update_action string
  • wishlists object
    • add string
    • all string
    • delete string
    • edit string
• auth object
  • check_login string
  • create_account string
  • forgot_password string
  • login string
  • logout string
  • save_new_account string
  • save_new_password string
  • send_password_email string
• brands string
• cart string
• checkout object
  • multiple_address string
  • single_address string
• compare string
• contact_us_submit string
• gift_certificate object
  • balance string
  • purchase string
  • redeem string
• home string
• product object
  • post_review string
• search string
• sitemap string
• subscribe object
  • action string

vault

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

Handlebars Expression: {{vault}}

Properties:

• access_token string — Required to submit add payment method form; otherwise, submission will fail with 401 Unauthorized.
• expires_at number — Expiration Date in Unix Timestamp.

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

Properties:

• 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
  • add_to_cart_url string
  • add_to_wishlist_url string
  • availability object
  • brand object
    • name object
  • custom_fields array
    • id number
    • name string
    • value string
  • date_added string
  • demo boolean
  • has_options boolean
  • id number
  • image object (external ref)
  • images array
  • low_stock_level object
  • name string
  • num_reviews object
  • pre_order boolean
  • price object
    • tax_label string
    • without_tax object
      • currency string
      • formatted string
      • value number
  • product_id number
  • qty_in_cart number
  • rating object
  • remove_url string — URL to remove the product from the wishlist.
  • show_cart_action boolean
  • sku object
  • stock_level object
  • summary string
  • url string
  • weight object
    • formatted object
    • value object
• name string — Customer-defined name of the wishlist.
• pagination object
  • current number
  • links array
    • number number
    • url string
  • next object
  • previous object
• share_url string — URL used to share the wishlist.
• token string — Unique public token for the wishlist.