{"_id":"58082badb2524d0f00350607","__v":1,"project":"55a6e72e8cc73e0d00096635","user":"55a6caa022cfa321008e01d6","version":{"_id":"55a6e72f8cc73e0d00096638","project":"55a6e72e8cc73e0d00096635","hasReference":false,"__v":29,"hasDoc":true,"createdAt":"2015-07-15T23:05:19.125Z","releaseDate":"2015-07-15T23:05:19.125Z","categories":["55a6e7308cc73e0d00096639","55b7ed07aea7c8190058badb","5604567c0c78b00d0039b191","5605e6f23a93940d002b3e4a","5605f2bba4574a0d00811365","5605f309a4574a0d00811366","5608e3b98aedf50d0004cf8f","5608e4318aedf50d0004cf90","5608e6b5a7cc2f0d00d9754d","5608e6d331beb60d001b6560","5608f879a7cc2f0d00d97580","560b097887b71d0d000d3bd9","560b13cbafa0990d00979545","560b5cbec341310d00de2a01","560b5cd0c341310d00de2a02","566a35b81e08750d00a0c49b","566a3e8503b4b20d00d02a4a","567889d307bf6a0d0083edc8","569c8b7c15bb390d00db6f9d","56b254dc65ddf50d0076ba8f","57a8ebc4cdeea20e001d2a63","57e48a4000c8680e00fae6e7","5808216773557d0f00a1e428","58105ad54a8aa50f00aa4cba","58105bf298aea40f00afa3ba","58105f548a4aed0f00d67536","581061b898aea40f00afa3be","584b3de7e5f3a42300df6ef7","596839a75965d400155bb750"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5808216773557d0f00a1e428","version":"55a6e72f8cc73e0d00096638","__v":0,"project":"55a6e72e8cc73e0d00096635","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-10-20T01:44:07.096Z","from_sync":false,"order":10,"slug":"stencil-object-model-reference","title":"Stencil Object Model Reference"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-20T02:27:57.408Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":19,"body":"[block:html]\n{\n  \"html\": \"<A NAME=\\\"Settings\\\"></a>\\n<b>Description: </b>Common settings shared across every BigCommerce storefront<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{settings}}</span><br>\\n\\n<b>Object Properties:</b><br><br>\\n\\n<table>\\n  <tr>\\n    <td>Property</td>\\n    <td>Description</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">account_creation_enabled</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to allow customers to create accounts</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_product_rating</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to display product ratings (in numeric or star format) to visitors</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_product_reviews</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to display full-text product reviews to visitors</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_newsletter_box</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to display a mailing-list invite to visitors</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"> gift_certificates_enabled</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to enable the gift certificate system for this store</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\"> blog_enabled</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether the blog is visible for this store</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">show_wishlist</td>\\n    <td class=\\\"\\\">Site-wide boolean value that indicates whether to allow customers to create wishlists</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">base_url</td>\\n    <td class=\\\"\\\">The normal shop URL</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">client_ip_address</td>\\n    <td class=\\\"\\\">IP address of the customer browsing the store</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">secure_base_url</td>\\n    <td class=\\\"\\\">The SSL-enabled, secure, shop URL</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">address</td>\\n    <td class=\\\"\\\">Store’s complete physical address, as entered by merchant in the Store Profile</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">store_name</td>\\n    <td class=\\\"\\\">Name of the BigCommerce store</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">store_logo</td>\\n    <td class=\\\"\\\">The store’s logo</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">title</span></td>\\n    <td class=\\\"\\\">Title for the logo &ndash; the text configured in the control panel under <NOBR><span class=\\\"inline-code\\\">Storefront Design</span></nobr> > <span class=\\\"inline-code\\\">Design Options</span> > <span class=\\\"inline-code\\\">Logo</span></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">image</span></td>\\n    <td class=\\\"\\\">Optional image file, as a <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image</a> object</td>\\n  </tr>\\n    \\n  <tr>\\n    <td class=\\\"\\\">privacy_cookie</td>\\n    <td class=\\\"\\\">If enabled, a string containing merchant-customizable text for (European Union&ndash;required) cookie-setting notification; if disabled, a boolean with a value of <span class=\\\"inline-code\\\">false</span></td>\\n  </tr>\\n<!-- Next 2 sub-items moved up under store_logo, where they belonged: -->\\n  <!-- <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">image</span></td>\\n    <td class=\\\"\\\">Optional image file, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">title</span></td>\\n    <td class=\\\"\\\">Title for the logo</td>\\n  </tr> -->\\n  \\n  <tr>\\n    <td class=\\\"\\\">urls</td>\\n    <td class=\\\"\\\">Global URLs that the template can access – for example, the template could link to the cart page using <span class=\\\"inline-code\\\">{{urls.cart}}</span></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> home</span></td>\\n    <td class=\\\"\\\">Store’s home page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> account</span></td>\\n    <td class=\\\"\\\">Collection of (customer and storefront) account-related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">index</span></td>\\n    <td class=\\\"\\\">Account index page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">orders</span></td>\\n    <td class=\\\"\\\">Collection of orders-related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> all</span></td>\\n    <td class=\\\"\\\">List of all orders</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> save_new_return</span></td>\\n    <td class=\\\"\\\">URL to submit a New Return form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> update_action</span></td>\\n    <td class=\\\"\\\">URL to submit an Edit Account form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> returns</span></td>\\n    <td class=\\\"\\\">List of returns</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> addresses</span></td>\\n    <td class=\\\"\\\">List of addresses; default sorting is by address id, from lowest to highest</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> inbox</span></td>\\n    <td class=\\\"\\\">List of messages in customer’s inbox</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> send_message</span></td>\\n    <td class=\\\"\\\">URL to submit a message to the merchant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> add_address</span></td>\\n    <td class=\\\"\\\">Link to Add Address form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> wishlists</span></td>\\n    <td class=\\\"\\\">Collection of wishlist-related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> add</span></td>\\n    <td class=\\\"\\\">URL to the Add Wishlist form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> edit</span></td>\\n    <td class=\\\"\\\">URL to the Edit Wishlist form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> delete</span></td>\\n    <td class=\\\"\\\">URL to delete a wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> all</span></td>\\n    <td class=\\\"\\\">URL to view all wishlists</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> details</span></td>\\n    <td class=\\\"\\\">URL to the Edit Account form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> recent_items</span></td>\\n    <td class=\\\"\\\">URL to a list of recently viewed items</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> brands</span></td>\\n    <td class=\\\"\\\">URL to view all brands; default sorting is by brand id, from lowest to highest</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> gift_certificate</span></td>\\n    <td class=\\\"\\\">Collection of gift-certificate–related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> purchase</span></td>\\n    <td class=\\\"\\\">URL to a form for purchasing a gift certificate</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> redeem</span></td>\\n    <td class=\\\"\\\">URL to view redemption information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> balance</span></td>\\n    <td class=\\\"\\\">URL to check the balance of a gift certificate</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> auth</span></td>\\n    <td class=\\\"\\\">Collection of authorization-related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> login</span></td>\\n    <td class=\\\"\\\">URL to the login form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> check_login</span></td>\\n    <td class=\\\"\\\">URL to which to submit the login form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> create_account</span></td>\\n    <td class=\\\"\\\">URL to the Create Account form page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> save_new_account</span></td>\\n    <td class=\\\"\\\">URL to which to submit the Create Account form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">forgot_password</span></td>\\n    <td class=\\\"\\\">URL to the Forgot Password form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">send_password_email</span></td>\\n    <td class=\\\"\\\">Submission URL for the Forgot Password form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">save_new_password</span></td>\\n    <td class=\\\"\\\">Submission URL for saving a new password</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> logout</span></td>\\n    <td class=\\\"\\\">URL for customer to log out of their account</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> product</span></td>\\n    <td class=\\\"\\\">Collection of product-related URLs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> post_review</span></td>\\n    <td class=\\\"\\\">URL to submit a Write Review form </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> cart</span></td>\\n    <td class=\\\"\\\">URL to the cart page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> checkout </span></td>\\n    <td class=\\\"\\\">Collection of checkout related URLs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> single_address </span></td>\\n    <td class=\\\"\\\">URL for the customer to check out with a single shipping address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> multiple_address </span></td>\\n    <td class=\\\"\\\">URL for the customer to check out with multiple shipping addresses </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> rss</span></td>\\n    <td class=\\\"\\\">Collection of RSS-related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> products</span></td>\\n    <td class=\\\"\\\">Collection of product-feed–related URLs:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> new</span></td>\\n    <td class=\\\"\\\">RSS feed of new products</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> new_atom</span></td>\\n    <td class=\\\"\\\">RSS feed of new products, in Atom format</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> popular</span></td>\\n    <td class=\\\"\\\">RSS feed of popular products</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> popular_atom</span></td>\\n    <td class=\\\"\\\">RSS feed of popular products, in Atom format</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> featured</span></td>\\n    <td class=\\\"\\\">RSS feed of featured products</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> featured_atom</span></td>\\n    <td class=\\\"\\\">RSS feed of featured products, in Atom format</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> search</span></td>\\n    <td class=\\\"\\\">RSS feed of products matching the active search query</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> search_atom</span></td>\\n    <td class=\\\"\\\">RSS feed of products matching the active search query, in Atom format</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> blog</span></td>\\n    <td class=\\\"\\\">RSS feed of recent blog posts</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> blog_atom</span></td>\\n    <td class=\\\"\\\">RSS feed of recent blog posts, in Atom format</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> contact_us_submit</span></td>\\n    <td class=\\\"\\\">URL to submit the Contact Us form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> search</span></td>\\n    <td class=\\\"\\\">URL to submit a search request</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> compare</span></td>\\n    <td class=\\\"\\\">A string String containing the URL to the products comparison page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> sitemap</span></td>\\n    <td class=\\\"\\\">URL to the sitemap</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> subscribe</span></td>\\n    <td class=\\\"\\\">Collection of subscription-related URLs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> action</span></td>\\n    <td class=\\\"\\\">URL to which the the newsletter subscription will be submitted</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">money</td>\\n    <td class=\\\"\\\">List of child items that define the store’s default currency formatting</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> currency_token</span></td>\\n    <td class=\\\"\\\">Symbol for the currency</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> currency_location</span></td>\\n    <td class=\\\"\\\">Whether currency symbol appears at left or right of the quantity</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> decimal_token</span></td>\\n    <td class=\\\"\\\">Symbol for decimal separator</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> decimal_places</span></td>\\n    <td class=\\\"\\\">Number of decimal places to display</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> thousands_token</span></td>\\n    <td class=\\\"\\\">Symbol for thousands separator</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">returns_enabled</td>\\n    <td class=\\\"\\\">Boolean that indicates whether the control-panel setting for the returns system is enabled</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">tax_label</td>\\n    <td class=\\\"\\\">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</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">add_this</td>\\n    <td class=\\\"\\\">Object that defines links for the AddThis social sharing component</td>\\n  </tr>  \\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> buttons</span></td>\\n    <td class=\\\"\\\">Array of buttons to display for AddThis social sharing</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">  service</span></td>\\n    <td class=\\\"\\\">String containing the name of this button's social-media service (<span class=\\\"inline-code\\\">facebook</span>, <span class=\\\"inline-code\\\">email</span>, <span class=\\\"inline-code\\\">print</span>, <span class=\\\"inline-code\\\">twitter</span>, <span class=\\\"inline-code\\\">linkedin</span>, <span class=\\\"inline-code\\\">google</span>, etc.)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">  annotation</span></td>\\n    <td class=\\\"\\\">String containing HTML attributes associated with this button</td>\\n  </tr>\\n    \\n  <tr>\\n    <td class=\\\"\\\">maintenance</td>\\n    <td class=\\\"\\\">Object that manages information about the store when in maintenance (offline) mode</td>\\n  </tr>  \\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> header</span></td>\\n    <td class=\\\"\\\">If store is in maintenance mode, string containing header text for the <NOBR>\\\"Down for Maintenance\\\"</nobr> window displayed to visitors; otherwise, <span class=\\\"inline-code\\\">null</span></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> message</span></td>\\n    <td class=\\\"\\\">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, <span class=\\\"inline-code\\\">null</span></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> notice</span></td>\\n    <td class=\\\"\\\">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: <span class=\\\"inline-code\\\">AdminPrelaunchNotice</span> for preview stores, <span class=\\\"inline-code\\\">AdminMaintenanceNotice</span> for active stores taken down for maintenance, or <span class=\\\"inline-code\\\">AdminHibernationModeNotice</span> for deactivated stores; otherwise, <span class=\\\"inline-code\\\">null</span></td>\\n  </tr>\\n    \\n  <tr>\\n    <td class=\\\"\\\">phone_number</td>\\n    <td class=\\\"\\\">The contact phone number for the store</td>\\n  </tr>  \\n\\n  <tr>\\n    <td class=\\\"\\\">rss_item_limit</td>\\n    <td class=\\\"\\\">An integer that sets a limit on the number of RSS items to display</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">password_requirements</td>\\n    <td class=\\\"\\\">Collection of properties representing BigCommerce requirements for customer-account passwords:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> alpha</span></td>\\n    <td class=\\\"\\\">Regular expression representing required/acceptable alphabetic characters</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> numeric</span></td>\\n    <td class=\\\"\\\">Regular expression representing required/acceptable numeric characters</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> minlength</span></td>\\n    <td class=\\\"\\\">Integer representing minimum acceptable password length</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> error</span></td>\\n    <td class=\\\"\\\">String that passes a standard error message for noncompliant passwords</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">measurements</td>\\n    <td class=\\\"\\\">Collection of units-of-measure definitions, to be used when displaying product details:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> length</span></td>\\n    <td class=\\\"\\\">Units of measure for product length</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> weight</span></td>\\n    <td class=\\\"\\\">Units of measure for product weight</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">[Time and date settings]</td>\\n    <td class=\\\"\\\">[The four settings below are configured in the control panel under <NOBR><span class=\\\"inline-code\\\">Store Setup</span> ></nobr> <NOBR><span class=\\\"inline-code\\\">Store  Settings</span></nobr> > <span class=\\\"inline-code\\\">Language & Date</span> > <span class=\\\"inline-code\\\">Date Settings</span>. <NOBR>Date formats</nobr> follow conventions from <a href=\\\"http://us3.php.net/manual/en/function.date.php\\\">http://www.php.net/date</a>:]</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">store_time_zone</td>\\n    <td class=\\\"\\\">Store's time zone, as selected in the control panel's <span class=\\\"inline-code\\\">Your Timezone</span> drop-down list</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">store_dst_correction</td>\\n    <td class=\\\"\\\">Whether or not this time zone observes Daylight Saving Time (boolean), as set by the control panel's <span class=\\\"inline-code\\\">Enable DST Correction</span> check box</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">display_date_format</td>\\n    <td class=\\\"\\\">Brief display format/pattern for dates, as configured in the control panel's <span class=\\\"inline-code\\\">Display Date Format</span> field</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">extended_display_date_format</td>\\n    <td class=\\\"\\\">Extended display format/pattern for dates, as configured in the control panel's <span class=\\\"inline-code\\\">Extended Display Date Format</span> field</td>\\n  </tr>   \\n</table>\"\n}\n[/block]","excerpt":"","slug":"settings-object","type":"basic","title":"Settings Object"}
[block:html] { "html": "<A NAME=\"Settings\"></a>\n<b>Description: </b>Common settings shared across every BigCommerce storefront<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{settings}}</span><br>\n\n<b>Object Properties:</b><br><br>\n\n<table>\n <tr>\n <td>Property</td>\n <td>Description</td>\n </tr>\n <tr>\n <td class=\"\">account_creation_enabled</td>\n <td class=\"\">Site-wide boolean value that indicates whether to allow customers to create accounts</td>\n </tr>\n <tr>\n <td class=\"\">show_product_rating</td>\n <td class=\"\">Site-wide boolean value that indicates whether to display product ratings (in numeric or star format) to visitors</td>\n </tr>\n <tr>\n <td class=\"\">show_product_reviews</td>\n <td class=\"\">Site-wide boolean value that indicates whether to display full-text product reviews to visitors</td>\n </tr>\n <tr>\n <td class=\"\">show_newsletter_box</td>\n <td class=\"\">Site-wide boolean value that indicates whether to display a mailing-list invite to visitors</td>\n </tr>\n <tr>\n <td class=\"\"> gift_certificates_enabled</td>\n <td class=\"\">Site-wide boolean value that indicates whether to enable the gift certificate system for this store</td>\n </tr>\n \n <tr>\n <td class=\"\"> blog_enabled</td>\n <td class=\"\">Site-wide boolean value that indicates whether the blog is visible for this store</td>\n </tr>\n \n <tr>\n <td class=\"\">show_wishlist</td>\n <td class=\"\">Site-wide boolean value that indicates whether to allow customers to create wishlists</td>\n </tr>\n <tr>\n <td class=\"\">base_url</td>\n <td class=\"\">The normal shop URL</td>\n </tr>\n <tr>\n <td class=\"\">client_ip_address</td>\n <td class=\"\">IP address of the customer browsing the store</td>\n </tr>\n <tr>\n <td class=\"\">secure_base_url</td>\n <td class=\"\">The SSL-enabled, secure, shop URL</td>\n </tr>\n <tr>\n <td class=\"\">address</td>\n <td class=\"\">Store’s complete physical address, as entered by merchant in the Store Profile</td>\n </tr>\n <tr>\n <td class=\"\">store_name</td>\n <td class=\"\">Name of the BigCommerce store</td>\n </tr>\n \n <tr>\n <td class=\"\">store_logo</td>\n <td class=\"\">The store’s logo</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">title</span></td>\n <td class=\"\">Title for the logo &ndash; the text configured in the control panel under <NOBR><span class=\"inline-code\">Storefront Design</span></nobr> > <span class=\"inline-code\">Design Options</span> > <span class=\"inline-code\">Logo</span></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">image</span></td>\n <td class=\"\">Optional image file, as a <a href=\"/docs/stencil-image-common-object\">Stencil image</a> object</td>\n </tr>\n \n <tr>\n <td class=\"\">privacy_cookie</td>\n <td class=\"\">If enabled, a string containing merchant-customizable text for (European Union&ndash;required) cookie-setting notification; if disabled, a boolean with a value of <span class=\"inline-code\">false</span></td>\n </tr>\n<!-- Next 2 sub-items moved up under store_logo, where they belonged: -->\n <!-- <tr>\n <td class=\"\"><span class=\"indent1\">image</span></td>\n <td class=\"\">Optional image file, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">title</span></td>\n <td class=\"\">Title for the logo</td>\n </tr> -->\n \n <tr>\n <td class=\"\">urls</td>\n <td class=\"\">Global URLs that the template can access – for example, the template could link to the cart page using <span class=\"inline-code\">{{urls.cart}}</span></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> home</span></td>\n <td class=\"\">Store’s home page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> account</span></td>\n <td class=\"\">Collection of (customer and storefront) account-related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">index</span></td>\n <td class=\"\">Account index page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">orders</span></td>\n <td class=\"\">Collection of orders-related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> all</span></td>\n <td class=\"\">List of all orders</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> save_new_return</span></td>\n <td class=\"\">URL to submit a New Return form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> update_action</span></td>\n <td class=\"\">URL to submit an Edit Account form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> returns</span></td>\n <td class=\"\">List of returns</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> addresses</span></td>\n <td class=\"\">List of addresses; default sorting is by address id, from lowest to highest</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> inbox</span></td>\n <td class=\"\">List of messages in customer’s inbox</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> send_message</span></td>\n <td class=\"\">URL to submit a message to the merchant</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> add_address</span></td>\n <td class=\"\">Link to Add Address form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> wishlists</span></td>\n <td class=\"\">Collection of wishlist-related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> add</span></td>\n <td class=\"\">URL to the Add Wishlist form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> edit</span></td>\n <td class=\"\">URL to the Edit Wishlist form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> delete</span></td>\n <td class=\"\">URL to delete a wishlist</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> all</span></td>\n <td class=\"\">URL to view all wishlists</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> details</span></td>\n <td class=\"\">URL to the Edit Account form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> recent_items</span></td>\n <td class=\"\">URL to a list of recently viewed items</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> brands</span></td>\n <td class=\"\">URL to view all brands; default sorting is by brand id, from lowest to highest</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> gift_certificate</span></td>\n <td class=\"\">Collection of gift-certificate–related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> purchase</span></td>\n <td class=\"\">URL to a form for purchasing a gift certificate</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> redeem</span></td>\n <td class=\"\">URL to view redemption information</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> balance</span></td>\n <td class=\"\">URL to check the balance of a gift certificate</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> auth</span></td>\n <td class=\"\">Collection of authorization-related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> login</span></td>\n <td class=\"\">URL to the login form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> check_login</span></td>\n <td class=\"\">URL to which to submit the login form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> create_account</span></td>\n <td class=\"\">URL to the Create Account form page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> save_new_account</span></td>\n <td class=\"\">URL to which to submit the Create Account form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">forgot_password</span></td>\n <td class=\"\">URL to the Forgot Password form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">send_password_email</span></td>\n <td class=\"\">Submission URL for the Forgot Password form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">save_new_password</span></td>\n <td class=\"\">Submission URL for saving a new password</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> logout</span></td>\n <td class=\"\">URL for customer to log out of their account</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> product</span></td>\n <td class=\"\">Collection of product-related URLs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> post_review</span></td>\n <td class=\"\">URL to submit a Write Review form </td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> cart</span></td>\n <td class=\"\">URL to the cart page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> checkout </span></td>\n <td class=\"\">Collection of checkout related URLs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> single_address </span></td>\n <td class=\"\">URL for the customer to check out with a single shipping address</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> multiple_address </span></td>\n <td class=\"\">URL for the customer to check out with multiple shipping addresses </td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> rss</span></td>\n <td class=\"\">Collection of RSS-related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> products</span></td>\n <td class=\"\">Collection of product-feed–related URLs:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> new</span></td>\n <td class=\"\">RSS feed of new products</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> new_atom</span></td>\n <td class=\"\">RSS feed of new products, in Atom format</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> popular</span></td>\n <td class=\"\">RSS feed of popular products</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> popular_atom</span></td>\n <td class=\"\">RSS feed of popular products, in Atom format</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> featured</span></td>\n <td class=\"\">RSS feed of featured products</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> featured_atom</span></td>\n <td class=\"\">RSS feed of featured products, in Atom format</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> search</span></td>\n <td class=\"\">RSS feed of products matching the active search query</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> search_atom</span></td>\n <td class=\"\">RSS feed of products matching the active search query, in Atom format</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> blog</span></td>\n <td class=\"\">RSS feed of recent blog posts</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> blog_atom</span></td>\n <td class=\"\">RSS feed of recent blog posts, in Atom format</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> contact_us_submit</span></td>\n <td class=\"\">URL to submit the Contact Us form</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> search</span></td>\n <td class=\"\">URL to submit a search request</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> compare</span></td>\n <td class=\"\">A string String containing the URL to the products comparison page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> sitemap</span></td>\n <td class=\"\">URL to the sitemap</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> subscribe</span></td>\n <td class=\"\">Collection of subscription-related URLs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> action</span></td>\n <td class=\"\">URL to which the the newsletter subscription will be submitted</td>\n </tr>\n <tr>\n <td class=\"\">money</td>\n <td class=\"\">List of child items that define the store’s default currency formatting</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> currency_token</span></td>\n <td class=\"\">Symbol for the currency</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> currency_location</span></td>\n <td class=\"\">Whether currency symbol appears at left or right of the quantity</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> decimal_token</span></td>\n <td class=\"\">Symbol for decimal separator</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> decimal_places</span></td>\n <td class=\"\">Number of decimal places to display</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> thousands_token</span></td>\n <td class=\"\">Symbol for thousands separator</td>\n </tr>\n <tr>\n <td class=\"\">returns_enabled</td>\n <td class=\"\">Boolean that indicates whether the control-panel setting for the returns system is enabled</td>\n </tr>\n <tr>\n <td class=\"\">tax_label</td>\n <td class=\"\">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</td>\n </tr>\n \n <tr>\n <td class=\"\">add_this</td>\n <td class=\"\">Object that defines links for the AddThis social sharing component</td>\n </tr> \n <tr>\n <td class=\"\"><span class=\"indent1\"> buttons</span></td>\n <td class=\"\">Array of buttons to display for AddThis social sharing</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> service</span></td>\n <td class=\"\">String containing the name of this button's social-media service (<span class=\"inline-code\">facebook</span>, <span class=\"inline-code\">email</span>, <span class=\"inline-code\">print</span>, <span class=\"inline-code\">twitter</span>, <span class=\"inline-code\">linkedin</span>, <span class=\"inline-code\">google</span>, etc.)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> annotation</span></td>\n <td class=\"\">String containing HTML attributes associated with this button</td>\n </tr>\n \n <tr>\n <td class=\"\">maintenance</td>\n <td class=\"\">Object that manages information about the store when in maintenance (offline) mode</td>\n </tr> \n <tr>\n <td class=\"\"><span class=\"indent1\"> header</span></td>\n <td class=\"\">If store is in maintenance mode, string containing header text for the <NOBR>\"Down for Maintenance\"</nobr> window displayed to visitors; otherwise, <span class=\"inline-code\">null</span></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> message</span></td>\n <td class=\"\">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, <span class=\"inline-code\">null</span></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> notice</span></td>\n <td class=\"\">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: <span class=\"inline-code\">AdminPrelaunchNotice</span> for preview stores, <span class=\"inline-code\">AdminMaintenanceNotice</span> for active stores taken down for maintenance, or <span class=\"inline-code\">AdminHibernationModeNotice</span> for deactivated stores; otherwise, <span class=\"inline-code\">null</span></td>\n </tr>\n \n <tr>\n <td class=\"\">phone_number</td>\n <td class=\"\">The contact phone number for the store</td>\n </tr> \n\n <tr>\n <td class=\"\">rss_item_limit</td>\n <td class=\"\">An integer that sets a limit on the number of RSS items to display</td>\n </tr>\n\n <tr>\n <td class=\"\">password_requirements</td>\n <td class=\"\">Collection of properties representing BigCommerce requirements for customer-account passwords:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> alpha</span></td>\n <td class=\"\">Regular expression representing required/acceptable alphabetic characters</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> numeric</span></td>\n <td class=\"\">Regular expression representing required/acceptable numeric characters</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> minlength</span></td>\n <td class=\"\">Integer representing minimum acceptable password length</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> error</span></td>\n <td class=\"\">String that passes a standard error message for noncompliant passwords</td>\n </tr>\n \n <tr>\n <td class=\"\">measurements</td>\n <td class=\"\">Collection of units-of-measure definitions, to be used when displaying product details:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> length</span></td>\n <td class=\"\">Units of measure for product length</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> weight</span></td>\n <td class=\"\">Units of measure for product weight</td>\n </tr>\n\n <tr>\n <td class=\"\">[Time and date settings]</td>\n <td class=\"\">[The four settings below are configured in the control panel under <NOBR><span class=\"inline-code\">Store Setup</span> ></nobr> <NOBR><span class=\"inline-code\">Store Settings</span></nobr> > <span class=\"inline-code\">Language & Date</span> > <span class=\"inline-code\">Date Settings</span>. <NOBR>Date formats</nobr> follow conventions from <a href=\"http://us3.php.net/manual/en/function.date.php\">http://www.php.net/date</a>:]</td>\n </tr>\n\n <tr>\n <td class=\"\">store_time_zone</td>\n <td class=\"\">Store's time zone, as selected in the control panel's <span class=\"inline-code\">Your Timezone</span> drop-down list</td>\n </tr>\n\n <tr>\n <td class=\"\">store_dst_correction</td>\n <td class=\"\">Whether or not this time zone observes Daylight Saving Time (boolean), as set by the control panel's <span class=\"inline-code\">Enable DST Correction</span> check box</td>\n </tr>\n\n <tr>\n <td class=\"\">display_date_format</td>\n <td class=\"\">Brief display format/pattern for dates, as configured in the control panel's <span class=\"inline-code\">Display Date Format</span> field</td>\n </tr>\n\n <tr>\n <td class=\"\">extended_display_date_format</td>\n <td class=\"\">Extended display format/pattern for dates, as configured in the control panel's <span class=\"inline-code\">Extended Display Date Format</span> field</td>\n </tr> \n</table>" } [/block]