{"_id":"560ae48d87b71d0d000d3b67","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,"__v":16,"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"},"project":"55a6e72e8cc73e0d00096635","user":"55a6caa022cfa321008e01d6","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-29T19:20:45.209Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":33,"body":"[block:html]\n{\n  \"html\": \"<a name=\\\"Stencil-Brand-ref\\\"></a>Brand objects map to the product brands sold by the merchant:<br>\\n\\n<ul>\\n  <li><a href=\\\"#BrandList\\\">Brand List</a></li>\\n <li><a href=\\\"#Brand\\\">Brand</a></li>\\n <li><a href=\\\"#ShopByBrand\\\">Shop by Brand</a></li>\\n</ul>\\n\\n\\n<h2> <A NAME=\\\"BrandList\\\"></a>Brand List</h2>\\n\\n<b>Description:</b> A list of brands with their basic data. Default sorting is by brand id, from lowest to highest. <NOBR>(Called on the</nobr> default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/brands.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{brands}}</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 to this brand’s products listing</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Name of the brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">id</td>\\n    <td class=\\\"\\\">Internal identifier for the brand </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\"><a href=\\\"/docs/stencil-image-common-object\\\">Stencil image object</a> (if any) for the brand</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Brand\\\"></a>Brand</h2>\\n\\n<b>Description:</b> The brand object for the page calling the object. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/brand.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{brand}}</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=\\\"\\\">show_compare</td>\\n    <td class=\\\"\\\">Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL of the brand page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Name of the brand </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">pagination</td>\\n    <td class=\\\"\\\">References the pagination model</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\">Image used to visually represent the brand (i.e., logo)</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=\\\"\\\">facets</td>\\n    <td class=\\\"\\\">A list of all possible search filters for this brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">products</td>\\n    <td class=\\\"\\\">An array of <a href=\\\"/docs/common-product-card-model\\\">product card models</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">selected</td>\\n    <td class=\\\"\\\">An array of selected facets</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"ShopByBrand\\\"></a>Shop by Brand</h2>\\n\\n<b>Description:</b> Objects to enable customers to shop by brand. Returns top 10 brands, by product count. <NOBR>(Called on the</nobr> default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/brand/sidebar.html</span></nobr> and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/common/footer.html</span></nobr> partials.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{shop_by_brand}}</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=\\\"\\\">links</td>\\n    <td class=\\\"\\\">Array of links to individual brands</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">ID for this brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">url</span></td>\\n    <td class=\\\"\\\">URL for this brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">name</span></td>\\n    <td class=\\\"\\\">Name of this brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">count</span></td>\\n    <td class=\\\"\\\">Number of products matching this brand</td>\\n  </tr>\\n</table>\"\n}\n[/block]","excerpt":"","slug":"brand-resources","type":"basic","title":"Brand Objects"}
[block:html] { "html": "<a name=\"Stencil-Brand-ref\"></a>Brand objects map to the product brands sold by the merchant:<br>\n\n<ul>\n <li><a href=\"#BrandList\">Brand List</a></li>\n <li><a href=\"#Brand\">Brand</a></li>\n <li><a href=\"#ShopByBrand\">Shop by Brand</a></li>\n</ul>\n\n\n<h2> <A NAME=\"BrandList\"></a>Brand List</h2>\n\n<b>Description:</b> A list of brands with their basic data. Default sorting is by brand id, from lowest to highest. <NOBR>(Called on the</nobr> default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/brands.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{brands}}</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 to this brand’s products listing</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Name of the brand</td>\n </tr>\n <tr>\n <td class=\"\">id</td>\n <td class=\"\">Internal identifier for the brand </td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\"><a href=\"/docs/stencil-image-common-object\">Stencil image object</a> (if any) for the brand</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Brand\"></a>Brand</h2>\n\n<b>Description:</b> The brand object for the page calling the object. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/brand.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{brand}}</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=\"\">show_compare</td>\n <td class=\"\">Boolean corresponding to merchant’s control panel selection whether or not to enable product comparisons</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL of the brand page</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Name of the brand </td>\n </tr>\n <tr>\n <td class=\"\">pagination</td>\n <td class=\"\">References the pagination model</td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\">Image used to visually represent the brand (i.e., logo)</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=\"\">facets</td>\n <td class=\"\">A list of all possible search filters for this brand</td>\n </tr>\n <tr>\n <td class=\"\">products</td>\n <td class=\"\">An array of <a href=\"/docs/common-product-card-model\">product card models</a></td>\n </tr>\n <tr>\n <td class=\"\">selected</td>\n <td class=\"\">An array of selected facets</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"ShopByBrand\"></a>Shop by Brand</h2>\n\n<b>Description:</b> Objects to enable customers to shop by brand. Returns top 10 brands, by product count. <NOBR>(Called on the</nobr> default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/brand/sidebar.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/common/footer.html</span></nobr> partials.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{shop_by_brand}}</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=\"\">links</td>\n <td class=\"\">Array of links to individual brands</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">ID for this brand</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">url</span></td>\n <td class=\"\">URL for this brand</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">name</span></td>\n <td class=\"\">Name of this brand</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">count</span></td>\n <td class=\"\">Number of products matching this brand</td>\n </tr>\n</table>" } [/block]