{"_id":"560ae450667dc90d0024df11","project":"55a6e72e8cc73e0d00096635","user":"55a6caa022cfa321008e01d6","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,"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"},"__v":35,"updates":["568c3f818656f42300b1f328"],"next":{"pages":[],"description":""},"createdAt":"2015-09-29T19:19:44.767Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":32,"body":"[block:html]\n{\n  \"html\": \"<a name=\\\"Stencil-Category-ref\\\"></a>Category objects map to the storefront's product categories, defined by the merchant:<br>\\n\\n<ul>\\n  <li><a href=\\\"#Category\\\">Category</a></li>\\n <li><a href=\\\"#CatProd\\\">Category Products</a></li>\\n <li><a href=\\\"#ShopByPrice\\\">Category Shop by Price</a></li>\\n</ul>\\n\\n<h2> <A NAME=\\\"Category\\\"></a>Category</h2> \\n\\n<b>Description:</b> The category object for the page calling the object. When retrieving a collection of categories, default sorting is by category <span class=\\\"inline-code\\\">id</span>, from lowest to highest. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/category.html</span></nobr> template, and on several partials in the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: <NOBR><span class=\\\"inline-code\\\">category/shop-by-price.html</span></nobr>, <NOBR><span class=\\\"inline-code\\\">category/sidebar.html</span></nobr>, and <NOBR><span class=\\\"inline-code\\\">amp/category/subcategories.html</span></nobr>.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{category}}</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=\\\"\\\">id</td>\\n    <td class=\\\"\\\">Unique ID for the category </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Merchant-defined category name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL for the category-specific page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">description</td>\\n    <td class=\\\"\\\">Merchant-defined description of the category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\">Image representing this category, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a></td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">subcategories <!-- Possible change to `children`--></td>\\n    <td class=\\\"\\\">List of any child categories</td>\\n  </tr>\\n<!-- New for MERC-268: -->  \\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">Unique ID for the subcategory </td>\\n  </tr>\\n<!-- :New for MERC-268 -->\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">name</span></td>\\n    <td class=\\\"\\\">Name of the subcategory</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">url</span></td>\\n    <td class=\\\"\\\">URL to the subcategory</td>\\n  </tr>\\n\\n<!-- New for MERC-268: -->  \\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">description</span></td>\\n    <td class=\\\"\\\">Merchant-defined description of the subcategory </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">image</span></td>\\n    <td class=\\\"\\\">Image representing this subcategory, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a></td>\\n  </tr> \\n<!-- :New for MERC-268 -->  \\n\\n<!-- New for MERC-320: -->  \\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">product_count</span></td>\\n    <td class=\\\"\\\">Number of products in the subcategory. (Counts at the current level only &ndash; not recursive to deeper levels.)</td>\\n  </tr>\\n<!-- :New for MERC-320 -->  \\n  \\n  <tr>\\n  \\t<td class=\\\"\\\">detail_messages</td>\\n    <td class=\\\"\\\">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.)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_compare</td>\\n    <td class=\\\"\\\">Boolean that defines whether to show controls for product comparison</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_add_to_cart</td>\\n    <td class=\\\"\\\">Boolean that defines whether to show an Add to Cart button for this category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">total_products</td>\\n    <td class=\\\"\\\">Count of the number of products in the category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">faceted_search_enabled</td>\\n    <td class=\\\"\\\">Boolean that defines whether product-filtering search is enabled for the store</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">facets</span></td>\\n    <td class=\\\"\\\">Available search facets</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">pagination</span></td>\\n    <td class=\\\"\\\">References the pagination model</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">selected</span></td>\\n    <td class=\\\"\\\">Selected search facets</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"CatProd\\\"></a>Category Products</h2>\\n\\n<b>Description:</b> A list of products associated with this category. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/category.html</span></nobr> template, and on the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/category/product-listing.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{category.products}}</span><br>\\n\\n<b>Object Properties:</b> References the  <a href=\\\"/docs/common-product-card-model\\\">product card model</a>.<br><br>\\n\\n\\n<h2> <A NAME=\\\"ShopByPrice\\\"></a>Category Shop by Price</h2>\\n\\n<b>Description:</b> A list of price ranges, to enable customers to set price limits within a product category. <NOBR>(Called on the default</nobr> <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/category/shop-by-price.html</span></nobr> and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/category/sidebar.html</span></nobr> partials.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{category.shop_by_price}}</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=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL of price-filtered product results for this category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">low</td>\\n    <td class=\\\"\\\"><a href=\\\"/docs/price-common-object\\\">Price object</a> that defines the minimum price boundary </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">high</td>\\n    <td class=\\\"\\\"><a href=\\\"/docs/price-common-object\\\">Price object</a> that defines the maximum price boundary</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">selected</td>\\n    <td class=\\\"\\\"><a href=\\\"/docs/price-common-object\\\">Price object</a> that defines the currently selected price range</td>\\n  </tr>\\n</table>\"\n}\n[/block]","excerpt":"","slug":"category-resources","type":"basic","title":"Category Objects"}
[block:html] { "html": "<a name=\"Stencil-Category-ref\"></a>Category objects map to the storefront's product categories, defined by the merchant:<br>\n\n<ul>\n <li><a href=\"#Category\">Category</a></li>\n <li><a href=\"#CatProd\">Category Products</a></li>\n <li><a href=\"#ShopByPrice\">Category Shop by Price</a></li>\n</ul>\n\n<h2> <A NAME=\"Category\"></a>Category</h2> \n\n<b>Description:</b> The category object for the page calling the object. When retrieving a collection of categories, default sorting is by category <span class=\"inline-code\">id</span>, from lowest to highest. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/category.html</span></nobr> template, and on several partials in the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: <NOBR><span class=\"inline-code\">category/shop-by-price.html</span></nobr>, <NOBR><span class=\"inline-code\">category/sidebar.html</span></nobr>, and <NOBR><span class=\"inline-code\">amp/category/subcategories.html</span></nobr>.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{category}}</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=\"\">id</td>\n <td class=\"\">Unique ID for the category </td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Merchant-defined category name</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL for the category-specific page</td>\n </tr>\n <tr>\n <td class=\"\">description</td>\n <td class=\"\">Merchant-defined description of the category</td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\">Image representing this category, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a></td>\n </tr>\n \n <tr>\n <td class=\"\">subcategories <!-- Possible change to `children`--></td>\n <td class=\"\">List of any child categories</td>\n </tr>\n<!-- New for MERC-268: --> \n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">Unique ID for the subcategory </td>\n </tr>\n<!-- :New for MERC-268 -->\n <tr>\n <td class=\"\"><span class=\"indent1\">name</span></td>\n <td class=\"\">Name of the subcategory</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">url</span></td>\n <td class=\"\">URL to the subcategory</td>\n </tr>\n\n<!-- New for MERC-268: --> \n <tr>\n <td class=\"\"><span class=\"indent1\">description</span></td>\n <td class=\"\">Merchant-defined description of the subcategory </td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">image</span></td>\n <td class=\"\">Image representing this subcategory, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a></td>\n </tr> \n<!-- :New for MERC-268 --> \n\n<!-- New for MERC-320: --> \n <tr>\n <td class=\"\"><span class=\"indent1\">product_count</span></td>\n <td class=\"\">Number of products in the subcategory. (Counts at the current level only &ndash; not recursive to deeper levels.)</td>\n </tr>\n<!-- :New for MERC-320 --> \n \n <tr>\n \t<td class=\"\">detail_messages</td>\n <td class=\"\">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.)</td>\n </tr>\n <tr>\n <td class=\"\">show_compare</td>\n <td class=\"\">Boolean that defines whether to show controls for product comparison</td>\n </tr>\n <tr>\n <td class=\"\">show_add_to_cart</td>\n <td class=\"\">Boolean that defines whether to show an Add to Cart button for this category</td>\n </tr>\n <tr>\n <td class=\"\">total_products</td>\n <td class=\"\">Count of the number of products in the category</td>\n </tr>\n <tr>\n <td class=\"\">faceted_search_enabled</td>\n <td class=\"\">Boolean that defines whether product-filtering search is enabled for the store</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">facets</span></td>\n <td class=\"\">Available search facets</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">pagination</span></td>\n <td class=\"\">References the pagination model</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">selected</span></td>\n <td class=\"\">Selected search facets</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"CatProd\"></a>Category Products</h2>\n\n<b>Description:</b> A list of products associated with this category. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/category.html</span></nobr> template, and on the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/category/product-listing.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{category.products}}</span><br>\n\n<b>Object Properties:</b> References the <a href=\"/docs/common-product-card-model\">product card model</a>.<br><br>\n\n\n<h2> <A NAME=\"ShopByPrice\"></a>Category Shop by Price</h2>\n\n<b>Description:</b> A list of price ranges, to enable customers to set price limits within a product category. <NOBR>(Called on the default</nobr> <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/category/shop-by-price.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/category/sidebar.html</span></nobr> partials.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{category.shop_by_price}}</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=\"\">url</td>\n <td class=\"\">URL of price-filtered product results for this category</td>\n </tr>\n <tr>\n <td class=\"\">low</td>\n <td class=\"\"><a href=\"/docs/price-common-object\">Price object</a> that defines the minimum price boundary </td>\n </tr>\n <tr>\n <td class=\"\">high</td>\n <td class=\"\"><a href=\"/docs/price-common-object\">Price object</a> that defines the maximum price boundary</td>\n </tr>\n <tr>\n <td class=\"\">selected</td>\n <td class=\"\"><a href=\"/docs/price-common-object\">Price object</a> that defines the currently selected price range</td>\n </tr>\n</table>" } [/block]