Elements of marketing banners at pageʼs top and/or bottom.
global{{banners}} object
Handlebars Expressions
{{banners}},
{{{banners}}}
Handlebars Formatting Exception
Where a banner contains HTML, the banner helper must be placed in triple braces, as in this example {{{banners}}}.
(Double braces would escape the HTML.)
Limits
{{banners}} will only return the first 50 banners on each page.
bottomarray[string]
Array of HTML content/strings, for custom bottom-banner content; banners are populated from the BigCommerce control panel
toparray[string]
Array of HTML content/strings, for custom top-banner content; banners are populated from the BigCommerce control panel
blog
Blog-specific properties for the blog feature within BigCommerce storefronts. These objects are called on the default templates/components/blog/post.html partial.
global and template {{blog}} objects
Handlebars Expression{{blog}}
oneOf:
blog (blog page)
{{blog}} object available to blog and blog post templates and components
descriptionstring
Blog description.
namestring
Blog name.
postsarray[object]
An array of blog posts.
tagnull
The blogʼs tag.
urlstring
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}}
configarray[object]
faceted_search_enabledboolean
Boolean that defines whether product-filtering search is enabled for the store.
facetsarray[object]
A list of all possible search filters for this brand.
imageobject
{{*.image}} object used by various objects such as {{category.image}} and {{product.images[*]}}.
metaarray[object]
namestring
Name of the brand
productsarray[object]
An array of product card models.
search_errorboolean
selectedobject
An array of selected facets.
show_compareboolean
Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons.
statearray[object]
urlstring
URL of the brand page
brand_results
{{brand_results}} array
urlstring
Example: https://www.example/test-brand/
namestring
Example: Test brand
brands
{{brands}} object available to templates/pages/brands.html
idinteger
imageobject
{{*.image}} object used by various objects such as {{category.image}} and {{product.images[*]}}.
namestring
urlstring
breadcrumbs
Defines a pageʼs breadcrumbs. Available on virtually all pages that have a breadcrumb trail.
global{{breadcrumbs}} array
Handlebars Expression{{breadcrumbs}}
namestring
Displayed name of this breadcrumb element.
urlstring
URL of this breadcrumb element.
carousel
A list of images, text, and style assets for a storefront’s image slide show.
{{carousel}} array
Handlebars Expression{{carousel}}
slidesarray[object]
Object containing properties for each slide in the slideshow.
swap_frequencyinteger
Indicates how often (in seconds) the slides will change; the value must be between 1 and 90,000 seconds.
cart
The cart-specific properties for the current session.
{{cart}} object available to templates/pages/cart.html; contains cart_id if one exists.
Handlebars Expression: {{cart}}
additional_checkout_buttonsarray[string]
Generates checkout buttons for third-party payments (PayPal, Google Checkout, etc.)
couponsarray[object]
List of coupons applied to the cart; default sorting is by coupon ID, from lowest to highest.
discountobject
Discount being applied to the cart in the current session.
gift_certificatesarray[object]
List of gift certificates applied to the cart.
gift_wrapping_costobject
Price object that defines the cost associated with adding gift wrapping to the items in the cart.
grand_totalobject
Price object that defines the total cost of all the items in the cart. Incorporates estimated shipping, discounts, taxes, and gift wrapping.
itemsarray[object]
quantityinteger
shipping_handlingobject
Current configuration of the shipping estimator for this session’s current cart; will be null/undefined if the cart contains no physical products.
show_multiple_address_shippingboolean
Boolean: If > 1 physical items are in the cart, and checkout button is displayed: whether to also display the "Ship to multiple addresses" / "Multiple Shipping Addresses" user option.
show_primary_checkout_buttonboolean
Boolean that determines whether to show a checkout button.
status_messagesarray[object]
sub_totalobject
Price object that defines the total cost of all the items in the cart. Might or might not include tax, based on the tax display settings the merchant has configured. Excludes shipping, discounts, and gift wrapping.
taxesarray[object]
List of all applicable taxes for the cart.
cart_id
Returns the cart ID if one exists. To return more cart information use the Storefront Cart API.
global{{cart_id}}
Handlebars Expression: {{cart_id}}
categories
A array of category objects filled with all categories shown in the current page context; default sorting is by category ID, from lowest to highest
global{{categories}} array
Handlebars Expression: {{categories}}
countstring
Number of products in this category.
idstring
ID of the top-level category listed.
imageobject
{{*.image}} object used by various objects such as {{category.image}} and {{product.images[*]}}.
namestring
Name of the top-level category
urlstring
URL to the category page.
childrenarray[object]
List of child categories for this top-level category.
category
The category object for the page calling the object. When retrieving a collection of categories, default sorting is by category id, from lowest to highest. Called on the default templates/pages/category.html template, and on several partials in the <theme-name>/templates/components/ subdirectory: category/shop-by-price.html and category/sidebar.html.
Handlebars Expression: {{category}}
configarray[object]
descriptionstring
Merchant-defined description of the category.
detail_messagesarray[object]
Message displayed when a product is out of stock, and inventory settings are configured to redirect to a category: "Sorry, the product you tried to view is currently out of stock, here are some similar products we have available." (This phrasing is set by the BigCommerce App.)
faceted_search_enabledboolean
Boolean that defines whether product-filtering search is enabled for the store.
facetsarray[object]
Available search facets.
idinteger
Unique ID for the category.
imageobject
{{*.image}} object used by various objects such as {{category.image}} and {{product.images[*]}}.
metaarray[object]
namestring
Merchant-defined category name.
productsarray[object]
selectedarray[object]
Selected search facets.
shop_by_pricearray[object]
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.
show_compareinteger
Boolean that defines whether to show controls for product comparison
statearray[object]
subcategoriesarray[object]
List of any child categories.
total_productsinteger
Count of the number of products in the category.
urlstring
category_results
{{category_results}} array
urlstring
Example: https://www.example/card-testing/
namestring
Example: Card Testing
checkout
Used to access checkout content and data in templates\pages\order-confirmation.html.
The {{checkout}} object is available to checkout and order confirmation templates and components.
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}}
currencyarray[object]
Details about the currency associated with the country.
Object to enable the current customer to create a store account. (Called on the default <theme-name>/templates/pages/auth/create-account.html template.)
Handlebars Expression: {{forms.create_account}}
continue_urlstring
currency_selector
A list of all supported currencies, and the currency that is actively in use in the storefront.
global{{currency_selector}}
Handlebars Expression: {{currency_selector}}
active_currency_idstring
ID of the currency actively in use in the storefront.
active_currency_flagstring
Country flag used to represent the active currency.
active_currency_namestring
Name of the active currency.
active_currency_codestring
Code for the active currency.
currenciesarray[object]
List of all the currencies supported for this storefront.
customer
{{customer}} object available to templates and components with customer context such as page/contact-us-form.html, common/subscription-form.html, account/address-list.html, account/messages-form.html, and account/wishlist-list.html.
Handlebars Expression: {{customer}}
addressesarray[object]
The customer.addresses object available to templates/pages/account/addresses.html and other account address templates.
customer_group_idnumber
ID of this customerʼs group.
customer_group_namestring
Name of this customerʼs group.
edit_stored_instrumentstring
emailstring
Customer’s email address.
idinteger
Customerʼs ID.
namestring
Customerʼs name.
num_new_messagesinteger
Number of unread messages for this customer.
num_wishlistsstring
Number of wishlists for this customer.
ordersarray[object]
payment_methodsobject
customer.payment_methods object available to templates/pages/account/payment-methods.html.
One of:arrayobject
display_namestring
value from the name provided by merchants
add_urlnullstring
typestring
required
Allowed: CARD | PAYPAL
stored_instrumentsarray[object]
instrumentsarray[object]
phonestring
Customerʼs phone number.
recently_viewed_productsarray[object]
returnsarray[object]
customer.returns object available to templates/pages/account/returns.html.
shipping_addressobject
Shipping address used for the order.
shipping_addressesarray[object]
store_creditobject
Customerʼs store credit.
wishlistsarray[object]
customer.wishlists objects available to templates/components/account/wishlist-list.html and components.
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.
Example: "<p>We're happy to answer questions or help you with returns.<br />Please fill out the form below if you need assistance.</p>"
head
global{{head}} object containing data configured for the HTML <head> element.
Handlebars Expression: {{head}}
faviconstring
The storeʼs favicon.
meta_tagsstring
Meta tags to improve store SEO.
scriptsstring
Scripts to be loaded in the <head> tag.
stylesheetsstring
CSS files to be included.
titlestring
Current pageʼs title.
is_ajax
global{{is_ajax}} boolean; returns true if the current request is an AJAX request
Handlebars Expression: {{is_ajax}}
No properties available for this object.
order
The {{order}} object available to templates and components with order context.
Handlebars Expression: {{order}}
billing_addressobject
Billing address used for the order.
commentsstring
datestring
Date of the order
has_multiple_shipping_addressesboolean
idinteger
Unique, system-generated ID
invoice_urlstring
is_completeboolean
Boolean indicating that the order has been completed
is_digitalstring
itemsarray[object]
List of items for the order.
last_updatedstring
order_instructionsstring
payment_methodstring
Customer’s payment method for this order (payment gateway)
reorder_urlstring
URL to place reorders for items in this order.
return_urlstring
returns_enabledinteger
Boolean that indicates whether merchant allows products from the order to be returned.
shipping_addressobject
Shipping address used for the order.
shipping_address_countstring
Number of shipping addresses the customer has specified for this order.
shipping_methodstring
statusstring
Order status code
status_messagesarray[object]
Status message associated with the status code for the order
status_textstring
Status text associated with the status code for the order.
totalobject
Price object that defines the order’s total value
total_rowsarray[object]
A list of “total” rows containing total pricing information
pickup_addressobject
brandstring
page
{{page}} object present on content pages, forms, and RSS feeds.
Handlebars Expression: {{page}}
breadcrumbsarray[]
Present if page has ancestors.
contentstring
HTML content of the page
feedarray[object]
Present if page is an RSS feed page.
idinteger
sub_pagesarray[object]
Array of child pages
titlestring
Title of this child page
page_type
A string representing the type of page currently displayed.
global{{page_type}} string.
Handlebars Expression: {{page_type}}
All possible values for {{page-type}} are:
account_orderstatus
account_order
account_addressbook
shippingaddressform
account_new_return
add-wishlist
account_recentitems
account_downloaditem
editaccount
account_inbox
account_saved_return
account_returns
account_paymentmethods
account_addpaymentmethod
account_editpaymentmethod
login
createaccount_thanks
createaccount
getnewpassword
forgotpassword
blog
blog_post
brand
brands
cart
checkout
category*
compare
page_contact_form
error
404
giftcertificates
giftcertificates_balance
giftcertificates_redeem
default*
orderconfirmation
page*
product*
amp_product_options
search
rss
sitemap
newsletter_subscribe
wishlist
wishlists
The four most-commonly-used values for {{page_type}} are marked with asterisks.
pages
global{{pages}} object containing storefront content page data
Handlebars Expression: {{pages}}
URLstring
URL of the page.
childrenarray[object]
List of child pages for this page.
namestring
Name of the page.
pagination
{{pagination}} object available to templates containing paginated lists, such as templates/pages/category.html and templates/pages/brands.html.
Handlebars Expression: {{pagination}}
anyOf:
CategoryBrandBlog
categoryobject
price
non_sale_price_without_taxobject
Common price amount object
map_price_without_taxobject
Common price amount object
map_price_with_taxobject
Common price amount object
price_rangeobject
rrp_without_taxobject
Common price amount object
sale_price_without_taxobject
Common price amount object
savedobject
Common price amount object
tax_labelstring
Tax label (VAT, sales tax, etc.) displayed to customers.
without_taxobject
Common price amount object
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:
The company, product line, or trademark associated with the product.
bulk_discount_ratesarray[object]
List of discount rates for the current product
can_purchaseboolean
Boolean that indicates whether the product is available for purchase
cart_urlstring
URL to the customer's shopping cart
categoryarray[string]
conditionstring
Product condition
customizationsarray[string]
Product customizations (for example, a T-shirt size); these correspond to configurable fields and numeric-text product options in the BigCommerce control panel
custom_fieldsarray[object]
depthstring
The product's physical depth measurement.
descriptionstring
(HTML) description of the product
detail_messagesstring
Status messages for display at the top of the product page
gift_wrapping_availableboolean
Whether or not gift wrapping is enabled
gtinstring
Global Trade Item Number. An identifier for trade items that is incorporated into several product identification standards, such as ISBN, UPC, and EAN.
heightstring
The product's physical height measurement.
idinteger
Unique ID for the product
imagesarray[object]
List of all images for this product, in Stencil image format (as configured in config.json; used with the getImage Handlebars helper)
main_imageobject
Primary image to display when the product details page loads
max_purchase_quantityinteger
Maximum quantity that can be purchased at once
meta_descriptionstring
meta_keywordsstring
Optional search keywords that merchants may enter in the control panelʼs "Add a Product" or "Edit a Product" page, to characterize the product in meta tags and storefront searches.
min_purchase_quantityinteger
Minimum quantity that can be purchased at once
mpnstring
Manufacturer Part Number. It is used to reference and identify a product.
num_reviewsinteger
Number of reviews the product has
optionsarray[object]
out_of_stockboolean
Boolean that indicates whether the product is out of stock. Out of stock only applies to the default selection on page load. For example, if Product A is out of the "Small" size, but "Small" is selected by default, out_of_stock will return true, even if the product is not out of stock as a whole.
out_of_stock_messagestring
Out of stock messages for display on the product page
Example: Out of stock
page_titlestring
priceobject
ratinginteger
Rating for the product
related_productsarray[object]
reviewsobject
shippingobject
shipping_messagesarray[string]
show_quantity_inputinteger
skustring
Default product variant when no options are selected.
stock_levelstring
Indicates the number of items available for sale. Visible only when inventory tracking is turned on.
tagsarray[string]
Keywords by which this product can also be identified.
titlestring
Displayed name of the product
upcstring
Optional UPC code for the product
urlstring
URL to the product detail page
videosobject
Available if product has videos.
warrantystring
Optional warranty text set by the merchant
widthstring
The product's physical width measurement.
product_results
{{product_results}}
productsarray[object]
ratinginteger
num_reviewsinteger
priceobject
tax_labelstring
Example: Tax
categoryarray[object]
products
The {{products}} object available on pages with product cards like templates/pages/home.html; contains new, featured, and top_sellers.
newarray[object]
featuredarray[object]
Renders a list of all the featured products for the BigCommerce storefront.
top_sellersarray[object]
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}}
account_creation_enabledboolean
Site-wide boolean value that indicates whether to allow customers to create accounts.
add_thisobject
Object that defines links for the AddThis social sharing component.
addressstring
Store’s complete physical address, as entered by merchant in the store profile.
base_urlstring
The normal shop URL.
blog_enabledboolean
Site-wide boolean value that indicates whether the blog is visible for this storefront.
bulk_discount_enabledboolean
Boolean that return true if bulk discount is enabled on products.
cdn_urlstring
client_ip_addressstring
deprecated
The IP address of the customer browsing the storefront. An alternative to this deprecated field is using ipify API.
country_codestring
The country code corresponding to the IP.
data_tag_enabledboolean
Site-wide boolean that indicates whether GAEE is enabled in a theme. For {{settings.data_tag_enabled}} to be true, the enhanced_ecommerce key must be present in config.json and a GAEE experiment must be enabled along with GA property value set in Advanced Settings > Analytics > GA in the store control panel.
display_date_formatstring
Brief display format/pattern for dates, as configured in the control panelʼs Display Date Format field.
extended_display_date_formatstring
Extended display format/pattern for dates, as configured in the control panelʼs Extended Display Date Format field.
facebook_like_buttonobject
generalobject
gift_certificates_enabledboolean
Site-wide boolean value that indicates whether to enable the gift certificate system for this store.
is_eu_ip_addressboolean
deprecated
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.
maintenanceobject
Object that manages information about the store when in maintenance (offline) mode.
measurementsobject
Collection of units-of-measure definitions, to be used when displaying product details:
moneyobject
List of child items that define the store’s default currency formatting.
Collection of properties representing BigCommerce requirements for customer-account passwords:
payments_urlstring
Exposes the BigCommerce payments URL. https://payments.bigcommerce.com.
phone_numberstring
The contact phone number for the store located in the stores profile.
privacy_cookieboolean
If enabled, a string containing merchant-customizable text for (European Union–required) cookie-setting notification; if disabled, a boolean with a value of false.
region_codestring
deprecated
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.
requestobject
Object that contains details about the HTTP request.
returns_enabledinteger
Boolean that indicates whether the control-panel setting for the returns system is enabled.
rss_item_limitinteger
An integer that sets a limit on the number of RSS items to display.
secure_base_urlstring
The SSL-enabled, secure, shop URL.
secure_hoststring
Returns the SSL url for a store. Example: https://www.bigcommerce.com.
shopper_consent_tracking_enabledboolean
show_newsletter_boxinteger
Site-wide boolean value that indicates whether to display a mailing-list invite to visitors.
A boolean value. If true available payment methods on a store will be shown. If false they are hidden.
show_product_ratingboolean
Site-wide boolean value that indicates whether to display product ratings (in numeric or star format) to visitors.
show_product_reviewsboolean
Site-wide boolean value that indicates whether to display full-text product reviews to visitors.
show_wishlistboolean
Site-wide boolean value that indicates whether to allow customers to create wishlists.
store_dst_correctioninteger
Whether or not this time zone observes Daylight Saving Time (boolean), as set by the control panelʼs Enable DST Correction check box.
store_hashstring
Returns the store hash as a string.
store_logoobject
The store’s logo.
store_namestring
Name of the BigCommerce store.
store_time_zonestring
Storeʼs time zone, as selected in the control panelʼs Your Timezone dropdown list.
storefront_apiobject
tax_labelstring
Defines the Tax Label (VAT, Sales Tax, etc.) that a merchant can set in the control panel’s Settings > Tax page for display to customers.
theme_config_idstring
theme_session_idstring
theme_version_idstring
shipments
{{shipments}} array available to templates/pages/account/orders/details.html
date_shippedstring
shipping date for this shipment
shipping_methodstring
shipping method for this shipment
shipping_providerstring
shipping carrier for this shipment
shipping_trackobject
tracking information for this shipment
show_shipping_methodboolean
boolean indicating whether shipping method should be displayed to customer or not
shipping_messages
{{shipping_messages}} object available to templates/pages/home.html
shop_by_brand
Objects to enable customers to shop by brand. Returns top 10 brands, by product count. (Called on the default templates/components/brand/sidebar.html and templates/components/common/footer.html partials.)
global{{shop_by_brand}} array of top 10 brands by product count.
Handlebars Expression: {{shop_by_brand}}
countstring
Number of products matching this brand.
idstring
ID for this brand.
namestring
Name of this brand.
urlstring
URL for this brand.
sitemap
A list of all sitemap properties for this BigCommerce storefront: pages, categories, and brands.
{{sitemap}} object available to templates/pages/sitemap.html.
Handlebars Expression: {{sitemap}}
bodyarray[object]
List of all sitemap subsections
labelstring
Subsection title (pages, categories, brands).
show_all_linkboolean
subsection_urlstring
URL to subsection content (pages, categories, brands) of the sitemap.
titlestring
social_media
global{{social_media}} array of all social-media site links for the storefront.
Handlebars Expression: {{social_media}}
namestring
Internal name of this social-media platform. For example, instagram.
global{{urls}} object containing a collection of storefront pages and their sub-pages
accountobject
authobject
brandsstring
cartstring
checkoutobject
comparestring
contact_us_submitstring
gift_certificateobject
homestring
productobject
rssobject
searchstring
sitemapstring
subscribeobject
vault
{{vault}} object available to templates/pages/account/payment-methods.html.
Handlebars Expression: {{vault}}
access_tokenstring
Required to submit add payment method form; otherwise, submission will fail with 401 Unauthorized.
Example: {{token}}
expires_atnumber
Expiration Date in Unix Timestamp.
Example: 1616614163
wishlist
Wishlist information for a specific wishlist. (Called on the default templates/pages/account/wishlist-details.html template and the templates/components/account/wishlist-item-list.html partial.)
Handlebars Expression: {{wishlist}}
idnumber
Unique system ID for the wishlist.
is_editableboolean
is_publicboolean
Boolean value indicating whether the wishlist is publicly available.