{"_id":"58081ef3b2524d0f00350602","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"},"project":"55a6e72e8cc73e0d00096635","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":1,"parentDoc":null,"user":"55a6caa022cfa321008e01d6","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-20T01:33:39.741Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":18,"body":"[block:html]\n{\n  \"html\": \"<A NAME=\\\"Search\\\"></a>\\n<b>Description: </b>Defines search parameters for the merchant’s site<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{forms.search}}</span><br>\\n\\n<b>Object Properties:</b><br><br>\\n\\n<table>\\n  <tr>\\n    <td class=\\\"\\\">Property</td>\\n    <td class=\\\"\\\">Description</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">query</td>\\n    <td class=\\\"\\\">Active search query, if available</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">section</td>\\n    <td class=\\\"\\\">Active search-results section: either content or product</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">content_url</td>\\n    <td class=\\\"\\\">URL to the content section</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">product_url</td>\\n    <td class=\\\"\\\">URL to the product section</td>\\n  </tr>\\n  \\n  \\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Brand name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">suggested_query</td>\\n    <td class=\\\"\\\">An alternative query – related to the current query – that can be offered to substitute for misspelled entries</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">has_suggestions</td>\\n    <td class=\\\"\\\">Boolean – true if there is at least one of brand results, category results, or a (non-null) suggested_query</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">brand_results</td>\\n    <td class=\\\"\\\">Array of brands that match the search query; default sorting is by brand id, from lowest to highest</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL of the brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Displayed name for the brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">category_results</td>\\n    <td class=\\\"\\\">An array of category paths matching the search query; used to populate category suggestions</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL of the category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Displayed name for the category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">values</td>\\n    <td class=\\\"\\\">Values of the submitted search form</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">brand</td>\\n    <td class=\\\"\\\">Any brand ID that customer has selected from drop-down list</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">price_from</td>\\n    <td class=\\\"\\\">Any minimum price the customer has specified</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">price_to</td>\\n    <td class=\\\"\\\">Any maximum price the customer has specified</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">featured_products</td>\\n    <td class=\\\"\\\">Whether customer has chosen to view featured products: null = no preference; 1 = only featured products; 2 = only non-featured products</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">free_shipping</td>\\n    <td class=\\\"\\\">Value indicating customer’s preference for free shipping within search results: null = no preference; 1 = free shipping only; 2 = paid shipping only</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">result_count</td>\\n    <td class=\\\"\\\">Combined number of returned results for product and content search</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><a name=\\\"Stencil-SearchCatOpt-ref\\\"></a>category_options</td>\\n    <td class=\\\"\\\">Array of options to present to customer as search-by-category fields</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">id</td>\\n    <td class=\\\"\\\">Category ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Displayed name of the category</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">state</td>\\n    <td class=\\\"\\\">If category contains children, and customer selects a child category: Whether that category’s display will default to closed (collapsed) or opened (expanded)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">children</td>\\n    <td class=\\\"\\\">Array of objects representing a child category; recursively replicates the structure of its parent</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">content_results</td>\\n    <td class=\\\"\\\">Search results across blog posts and storefront pages (not products or categories)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">title</td>\\n    <td class=\\\"\\\">Title of the result (title embedded in blog post or page)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">content</td>\\n    <td class=\\\"\\\">Summary of text from the blog post or page (first 200 characters)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL to the result</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">type</td>\\n    <td class=\\\"\\\">Either post (for blog posts) or page (for storefront pages)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">product_results</td>\\n    <td class=\\\"\\\">Results of customer’s last search by product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">products</span></td>\\n    <td class=\\\"\\\">List of search results for a product; points to <a href=\\\"/docs/common-product-card-model\\\">product card model</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">show_compare</span></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=\\\"\\\"><span class=\\\"indent1\\\">faceted_search_enabled</span></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=\\\"\\\">All available search filters</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">pagination</span></td>\\n    <td class=\\\"\\\">References pagination model</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">selected</span></td>\\n    <td class=\\\"\\\">Currently selected filters</td>\\n  </tr>\\n</table>\\n\"\n}\n[/block]","excerpt":"","slug":"search-object","type":"basic","title":"Search Object"}
[block:html] { "html": "<A NAME=\"Search\"></a>\n<b>Description: </b>Defines search parameters for the merchant’s site<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{forms.search}}</span><br>\n\n<b>Object Properties:</b><br><br>\n\n<table>\n <tr>\n <td class=\"\">Property</td>\n <td class=\"\">Description</td>\n </tr>\n <tr>\n <td class=\"\">query</td>\n <td class=\"\">Active search query, if available</td>\n </tr>\n\n <tr>\n <td class=\"\">section</td>\n <td class=\"\">Active search-results section: either content or product</td>\n </tr>\n \n <tr>\n <td class=\"\">content_url</td>\n <td class=\"\">URL to the content section</td>\n </tr>\n \n <tr>\n <td class=\"\">product_url</td>\n <td class=\"\">URL to the product section</td>\n </tr>\n \n \n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Brand name</td>\n </tr>\n <tr>\n <td class=\"\">suggested_query</td>\n <td class=\"\">An alternative query – related to the current query – that can be offered to substitute for misspelled entries</td>\n </tr>\n <tr>\n <td class=\"\">has_suggestions</td>\n <td class=\"\">Boolean – true if there is at least one of brand results, category results, or a (non-null) suggested_query</td>\n </tr>\n <tr>\n <td class=\"\">brand_results</td>\n <td class=\"\">Array of brands that match the search query; default sorting is by brand id, from lowest to highest</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL of the brand</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Displayed name for the brand</td>\n </tr>\n <tr>\n <td class=\"\">category_results</td>\n <td class=\"\">An array of category paths matching the search query; used to populate category suggestions</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL of the category</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Displayed name for the category</td>\n </tr>\n <tr>\n <td class=\"\">values</td>\n <td class=\"\">Values of the submitted search form</td>\n </tr>\n <tr>\n <td class=\"\">brand</td>\n <td class=\"\">Any brand ID that customer has selected from drop-down list</td>\n </tr>\n <tr>\n <td class=\"\">price_from</td>\n <td class=\"\">Any minimum price the customer has specified</td>\n </tr>\n <tr>\n <td class=\"\">price_to</td>\n <td class=\"\">Any maximum price the customer has specified</td>\n </tr>\n <tr>\n <td class=\"\">featured_products</td>\n <td class=\"\">Whether customer has chosen to view featured products: null = no preference; 1 = only featured products; 2 = only non-featured products</td>\n </tr>\n <tr>\n <td class=\"\">free_shipping</td>\n <td class=\"\">Value indicating customer’s preference for free shipping within search results: null = no preference; 1 = free shipping only; 2 = paid shipping only</td>\n </tr>\n <tr>\n <td class=\"\">result_count</td>\n <td class=\"\">Combined number of returned results for product and content search</td>\n </tr>\n <tr>\n <td class=\"\"><a name=\"Stencil-SearchCatOpt-ref\"></a>category_options</td>\n <td class=\"\">Array of options to present to customer as search-by-category fields</td>\n </tr>\n <tr>\n <td class=\"\">id</td>\n <td class=\"\">Category ID</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Displayed name of the category</td>\n </tr>\n <tr>\n <td class=\"\">state</td>\n <td class=\"\">If category contains children, and customer selects a child category: Whether that category’s display will default to closed (collapsed) or opened (expanded)</td>\n </tr>\n <tr>\n <td class=\"\">children</td>\n <td class=\"\">Array of objects representing a child category; recursively replicates the structure of its parent</td>\n </tr>\n <tr>\n <td class=\"\">content_results</td>\n <td class=\"\">Search results across blog posts and storefront pages (not products or categories)</td>\n </tr>\n <tr>\n <td class=\"\">title</td>\n <td class=\"\">Title of the result (title embedded in blog post or page)</td>\n </tr>\n <tr>\n <td class=\"\">content</td>\n <td class=\"\">Summary of text from the blog post or page (first 200 characters)</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL to the result</td>\n </tr>\n <tr>\n <td class=\"\">type</td>\n <td class=\"\">Either post (for blog posts) or page (for storefront pages)</td>\n </tr>\n <tr>\n <td class=\"\">product_results</td>\n <td class=\"\">Results of customer’s last search by product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">products</span></td>\n <td class=\"\">List of search results for a product; points to <a href=\"/docs/common-product-card-model\">product card model</a></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">show_compare</span></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=\"\"><span class=\"indent1\">faceted_search_enabled</span></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=\"\">All available search filters</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">pagination</span></td>\n <td class=\"\">References pagination model</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">selected</span></td>\n <td class=\"\">Currently selected filters</td>\n </tr>\n</table>\n" } [/block]