{"_id":"560ae36e109fc70d00008cb4","__v":72,"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,"user":"55a6caa022cfa321008e01d6","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-29T19:15:58.417Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":31,"body":"[block:html]\n{\n  \"html\": \"<a name=\\\"Stencil-Product-ref\\\"></a>Product objects map to the products defined by the merchant for their BigCommerce storefront:<br>\\n\\n<ul>\\n  <!-- <li><a href=\\\"/docs/common-product-card-model\\n\\\">Common Product Card Model</a></li> -->\\n <li><a href=\\\"#Product\\\">Product</a></li>\\n <li><a href=\\\"#RelProd\\\">Related Products</a></li>\\n <li><a href=\\\"#Stencil-ProdRevu-ref\\\">Product Reviews</a></li>\\n <li><a href=\\\"#SimByView\\\">Similar Products by Customer Views</a></li>  \\n <li><a href=\\\"#Videos\\\">Product Videos</a></li>\\n <li><a href=\\\"#Compare\\\">Compare</a></li>\\n <li><a href=\\\"#DownItem\\\">Download Item</a></li>\\n <!-- <li><a href=\\\"#SimByTag\\\">Similar Products by Tag</a></li> -->\\n <li><a href=\\\"#ProdOtherDetails\\\">Product Other Details</a></li>\\n</ul>\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Please also see [Common Objects](/docs/common-object-formats) > [Common Product Card Model](/docs/common-product-card-model), which documents the product object returned in collections.\",\n  \"title\": \"Other Product Objects\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<!-- \\\"Common Product Card Model\\\" moved to \\\"Common Object Formats\\\" page: -->\\n\\n<!-- <h2> \\n<a name=\\\"Stencil-ProdCardObj-ref\\\"></a>Common Product Card Model </h2>\\n\\n<b>Description:</b> A model for a product’s basic, primary properties. Typically used for list components that show multiple products, each in its own \\\"card\\\" or panel.<br>\\n\\n<b>Handlebars Expression:</b> [N/A]<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=\\\"\\\">ID of the product </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Name of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL to product detail page for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">availability</td>\\n    <td class=\\\"\\\">Typical shipping time for the product; used to populate \\\"Usually ships within…\\\" fields</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">rating</td>\\n    <td class=\\\"\\\">Product’s rating</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">brand</td>\\n    <td class=\\\"\\\">Brand properties for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Product’s brand name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">add_to_cart_url</td>\\n    <td class=\\\"\\\">URL that adds this product to customer’s cart</td>\\n  </tr>\\n  <tr>\\n<td class=\\\"\\\">price </td>\\n    <td class=\\\"\\\">References the <a href=\\\"/docs/catalog-price-common-object\\\">catalog price object</a>, to access price properties in both raw-numeric and formatted/string formats</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">summary</td>\\n    <td class=\\\"\\\">Summary description of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\">Default image for the product, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image object format</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">date_added</td>\\n    <td class=\\\"\\\">Date the product was added to this BigCommerce storefront</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">pre_order</td>\\n    <td class=\\\"\\\">Product’s availability for pre-order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">release_date</td>\\n    <td class=\\\"\\\">Release date, if the product is set to pre-order status</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_cart_action</td>\\n    <td class=\\\"\\\">Boolean that indicates whether the product is available for purchase</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">has_options</td>\\n    <td class=\\\"\\\">Boolean that indicates whether customer is required to specify options when ordering the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">qty_in_cart</td>\\n    <td class=\\\"\\\">Quantity of this item in the customer’s cart</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">out_of_stock_message</td>\\n    <td class=\\\"\\\">Text to display when the product is out of stock</td>\\n  </tr>\\n</table> -->\\n\\n<!-- :\\\"Common Product Card Model\\\" moved to \\\"Common Object Formats\\\" page -->\\n\\n\\n<h2> <A NAME=\\\"Product\\\"></a>Product</h2>\\n\\n<b>Description:</b> Default property that provides detailed product data. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> and  <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/amp/product.html</span></nobr> templates, and on several partials in the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: <br>\\n<NOBR><span class=\\\"inline-code\\\">account/returns-list.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">cart/item-options.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">products/add-to-cart.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">products/event-date.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">products/modals/writeReview.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">products/price.html</span></nobr>, <NOBR><span class=\\\"inline-code\\\">products/product-view.html</span></nobr>,\\n<NOBR><span class=\\\"inline-code\\\">amp/products/product-options.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">amp/products/product-view.html</span></nobr>, and \\n<NOBR><span class=\\\"inline-code\\\">amp/products/product-view-details.html</span></nobr>.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product}}</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 product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">sku</td>\\n    <td class=\\\"\\\">Default product variant when no options are selected</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL to the product detail page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">upc</td>\\n    <td class=\\\"\\\">Optional UPC code for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">title</td>\\n    <td class=\\\"\\\">Displayed name of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">description</td>\\n    <td class=\\\"\\\">(HTML) description of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">detail_messages</td>\\n    <td class=\\\"\\\">Status messages for display at the top of the product page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">min_purchase_quantity</td>\\n    <td class=\\\"\\\">Minimum quantity that can be purchased at once</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">max_purchase_quantity</td>\\n    <td class=\\\"\\\">Maximum quantity that can be purchased at once</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">can_purchase</td>\\n    <td class=\\\"\\\">Boolean that indicates whether the product is available for purchase</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">out_of_stock</td>\\n    <td class=\\\"\\\">Boolean that indicates whether the product is out of stock</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">out_of_stock_message</td>\\n    <td class=\\\"\\\">Merchant-defined label to display when a product is out of stock</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">cart_url</td>\\n    <td class=\\\"\\\">URL to the customer’s shopping cart</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">add_to_wishlist_url</td>\\n    <td class=\\\"\\\">URL to add the product to the customer’s wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><a name=\\\"customizations\\\"></a> customizations </td>\\n    <td class=\\\"\\\">Product customizations (for example, a T-shirt size); these correspond to <NOBR><a href=\\\"https://support.bigcommerce.com/articles/Public/What-are-configurable-fields-and-how-do-I-create-them\\\">configurable fields</a></nobr> and <a href=\\\"https://support.bigcommerce.com/articles/Public/Product-Options-Text-Fields#numbers\\\">numeric-text</a> <a href=\\\"https://support.bigcommerce.com/articles/Public/Adding-Product-Options\\\">product options</a> in the BigCommerce control panel</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">Customization ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">display_name</span></td>\\n    <td class=\\\"\\\">Label for this customization, as displayed to customers</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">type</span></td>\\n    <td class=\\\"\\\">Customization type [<span class=\\\"inline-code\\\">text</span>|<span class=\\\"inline-code\\\">textarea</span>|<span class=\\\"inline-code\\\">NumbersOnlyText</span>|<span class=\\\"inline-code\\\">checkbox</span>|<span class=\\\"inline-code\\\">select</span>|<span class=\\\"inline-code\\\">file</span>]</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">required</span></td>\\n    <td class=\\\"\\\">Boolean value that indicates whether customer must specify this customization in order to buy the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">condition</span></td>\\n    <td class=\\\"\\\">Boolean value indicating whether to display this product's condition (new, used, or refurbished)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">prefill</span></td>\\n    <td class=\\\"\\\">Optional string value to prefill this field</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">&lt;values&gt;</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">select</span> type, array of strings listing the available options</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">\\n      <!-- <span class=\\\"inline-code\\\">&lt;textarea</span>=\\\"\\\"> -->\\n      <span class=\\\"indent1\\\">&lt;file_types&gt;</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">file</span> type, string representing the types of allowed files</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">&lt;file_size&gt;</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">file</span> type, string representing the maximum file size allowed</td>\\n  </tr>\\n  \\n<!-- Inserted new properties here for NumbersOnlyText type, MERC-159: -->\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">integer_only</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type, boolean value indicating whether to restrict customer's entries to whole numbers only</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">default</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type, optional string representing a default number that customers can see and overwrite</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">limit_input</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type, boolean indicating whether to impose any limits on the numeric values that customers can enter as strings</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">limit_input_option</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type and <span class=\\\"inline-code\\\">limit_input</span> = <span class=\\\"inline-code\\\">true</span>, the type of limit: <span class=\\\"inline-code\\\">lowest</span> or <span class=\\\"inline-code\\\">highest</span></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">lowest</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type and <span class=\\\"inline-code\\\">limit_input</span> = <span class=\\\"inline-code\\\">true</span>,  minimum allowable value; a value of <span class=\\\"inline-code\\\">0</span> imposes no limit</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">highest</span></td>\\n    <td class=\\\"\\\">For <span class=\\\"inline-code\\\">NumbersOnlyText</span> type and <span class=\\\"inline-code\\\">limit_input</span> = <span class=\\\"inline-code\\\">true</span>,  maximum allowable value; a value of <span class=\\\"inline-code\\\">0</span> imposes no limit</td>\\n  </tr>\\n<!-- End of customizations child object -->\\n  \\n<!-- Inserted new child object here for swatches, MERC-81: -->\\n  <tr>\\n    <td class=\\\"\\\"><a name=\\\"swatch_options\\\"></a>options</td>\\n    <td class=\\\"\\\">Options for color and pattern swatches displayed for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">Product ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">type</span></td>\\n    <td class=\\\"\\\">String indicating size, color, swatch, etc.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">display_name</span></td>\\n    <td class=\\\"\\\">Option Name displayed in control panel for this option</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">required</span></td>\\n    <td class=\\\"\\\">Boolean value that indicates whether customer must specify this option in order to buy the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">condition</span></td>\\n    <td class=\\\"\\\">Boolean value indicating whether to display this product's condition (new, used, or refurbished)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">values</span></td>\\n    <td class=\\\"\\\">Array of data (color) or image (pattern) values</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">label</span></td>\\n    <td class=\\\"\\\">Internal label for this value (not normally displayed to shoppers)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">id</span></td>\\n    <td class=\\\"\\\">ID for this value, unique within this values array</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">selected</span></td>\\n    <td class=\\\"\\\">Boolean indicating whether this value is preselected as the option's default value, upon page load</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">data</span></td>\\n    <td class=\\\"\\\">Each <span class=\\\"inline-code\\\">values</span> member can contain either a <span class=\\\"inline-code\\\">data</span> or an <span class=\\\"inline-code\\\">image</span> member; <span class=\\\"inline-code\\\">data</span> denotes a color</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\">&lt;color value&gt;</span></td>\\n    <td class=\\\"\\\">Hex code for this color</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">image</span></td>\\n    <td class=\\\"\\\">\\n      Each <span class=\\\"inline-code\\\">values</span> member can contain either a <span class=\\\"inline-code\\\">data</span> or an <span class=\\\"inline-code\\\">image</span> member; <span class=\\\"inline-code\\\">image</span> denotes a pattern, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image object format</a>. (Note: This <span class=\\\"inline-code\\\">image</span> value replaces the <span class=\\\"inline-code\\\">{{pattern}}</span> property, which was limited to 18 x 18 pixels, and will be deprecated.)</td>\\n  </tr>\\n<!-- ^ Inserted new object above for swatches, https://jira.bigcommerce.com/browse/MERC-81 -->\\n  \\n  <tr>\\n    <td class=\\\"\\\"><a name=\\\"price\\\"></a> price </td>\\n    <td class=\\\"\\\">References the <a href=\\\"/docs/catalog-price-common-object\\\">catalog price object</a>, to access the product’s price</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">weight</td>\\n    <td class=\\\"\\\">Weight of the default variant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">height</td>\\n    <td class=\\\"\\\">Height of the default variant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">width</td>\\n    <td class=\\\"\\\">Width of the default variant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">depth</td>\\n    <td class=\\\"\\\">Depth of the default variant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">rating</td>\\n    <td class=\\\"\\\">Rating for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">num_reviews</td>\\n    <td class=\\\"\\\">Number of reviews the product has</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">bulk_discount_rates </td>\\n    <td class=\\\"\\\">List of discount rates for the current product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">condition</td>\\n    <td class=\\\"\\\">Condition of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">stock_level</td>\\n    <td class=\\\"\\\">Current stock level of the product; will be null if storefront stock display is disabled by the merchant, or if the product lacks inventory tracking</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping</td>\\n    <td class=\\\"\\\">Shipping properties for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> fixed</span></td>\\n    <td class=\\\"\\\">Boolean that indicates whether the product’s shipping price is fixed</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> price</span></td>\\n    <td class=\\\"\\\"><a href=\\\"https://stencil.bigcommerce.com/docs/price-common-object\\\">Price object</a> that defines the shipping cost for this product (if shipping cost is fixed)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> calculated</span></td>\\n    <td class=\\\"\\\">Boolean that indicates whether the product’s shipping price is calculated at checkout</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">stock_label</td>\\n    <td class=\\\"\\\">Shows whether the product stock level is for on-hand merchandise or pre-orders.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">availability</td>\\n    <td class=\\\"\\\">Optional availability message set by the merchant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">pre_order</td>\\n    <td class=\\\"\\\">Availability of the product for pre-order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">release_date</td>\\n    <td class=\\\"\\\">Release date, if the product is set to pre-order status</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">error_message</td>\\n    <td class=\\\"\\\">Potential error on the page (e.g.: out of stock, form validations)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">gift_wrapping</td>\\n    <td class=\\\"\\\">Whether or not gift wrapping is enabled</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">brand</td>\\n    <td class=\\\"\\\">Brand of the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Displayed name of the brand</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> url</span></td>\\n    <td class=\\\"\\\">URL to the brand page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">main_image</td>\\n    <td class=\\\"\\\">Primary image to display when the product details page loads</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">images</td>\\n    <td class=\\\"\\\">List of all images for this product, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a> (as configured in config.json; used with the <span class=\\\"inline-code\\\"><a href=\\\"/docs/handlebars-helpers-reference#image\\\">getImage</a></span> Handlebars helper)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">pinterest_js</td>\\n    <td class=\\\"\\\">Property to display Pinterest button</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">facebook_like</td>\\n    <td class=\\\"\\\">Property to display Facebook Like button</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">warranty</td>\\n    <td class=\\\"\\\">Optional warranty text set by the merchant</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">search_keywords</td>\\n    <td class=\\\"\\\">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 </td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">tags</td>\\n    <td class=\\\"\\\">Keywords by which this product can also be identified</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Name of the tag</td>\\n  </tr>\\n  \\n  <tr>\\n    <td class=\\\"\\\">custom_fields </td>\\n    <td class=\\\"\\\">Extra details to display about the product </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Custom field name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> value</span></td>\\n    <td class=\\\"\\\">Custom field value</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">event_date</td>\\n    <td class=\\\"\\\">Property to handle a date-based product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Name of the event</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> date_start</span></td>\\n    <td class=\\\"\\\">Event’s start date range</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> date_end</span></td>\\n    <td class=\\\"\\\">Event’s end date range</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> earliest_year</span></td>\\n    <td class=\\\"\\\">Event’s starting year</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> latest_year</span></td>\\n    <td class=\\\"\\\">Event’s ending year</td>\\n  </tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> type</span></td>\\n    <td class=\\\"\\\">Type of event</td>\\n  </tr>\\n</table>\\n\\n<H3><a name=\\\"ProdOptionsIllus\\\"></a> {{product.options}} Example </h3>\\n\\nHere is an illustration of how the <span class=\\\"inline-code\\\">{{product.options}}</span> property works. This first image shows a merchant's selection (in the BigCommerce control panel) of an option with display type <span class=\\\"inline-code\\\">Swatch</span> and a subtype of <span class=\\\"inline-code\\\">Pattern</span>: \\n\\n<p></p><img src=\\\"https://files.readme.io/M7gbL8sTTOadKVqA242m_Product-Options~CP.png\\\" alt=\\\"Merchant's &ldquo;options &gt; Swatch &gt; Pattern&rdquo; selection in control panel\\\" height=\\\"359\\\" width=\\\"750\\\">\\n\\n<p></p>This second image shows the corresponding JSON (from Stencil's <a href=\\\"/docs/testingdebugging-themes\\\">debug</a> panel) rendered in the page context: <NOBR>The <span class=\\\"inline-code\\\">image</span></nobr> property will contain a URL, whose referenced image can be scaled as large as 150 x 150 pixels.\\n\\n<p></p><img src=\\\"https://files.readme.io/qAw6mOZQQJezOmX2Q5Qy_Product-Options~debug.JSON.png\\\" alt=\\\"Corresponding JSON rendered in page context\\\" height=\\\"278\\\" width=\\\"750\\\"><br><br>\\n\\n\\n<h2> <A NAME=\\\"RelProd\\\"></a>Related Products</h2>\\n\\n<b>Description:</b> A list of products related to this product. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/products/tabs.html</span></nobr> partial.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.related_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=\\\"Stencil-ProdRevu-ref\\\"></a>Product Reviews </h2>\\n\\n<b>Description:</b> A list of reviews related to this product. When filtering/limiting, reviews' default sorting is by review id, from lowest to highest. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> template, and on several partials in the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: \\n<NOBR><span class=\\\"inline-code\\\">products/product-view.html</span></nobr>, \\n<NOBR><span class=\\\"inline-code\\\">products/modals/writeReview.html</span></nobr>, and \\n<NOBR><span class=\\\"inline-code\\\">amp/products/product-view.html</span></nobr>.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.reviews}}</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=\\\"\\\">start</td>\\n    <td class=\\\"\\\">The review that starts the current page of reviews</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">total</td>\\n    <td class=\\\"\\\">Total number of reviews</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">end</td>\\n    <td class=\\\"\\\">Last review on this page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_review_email</td>\\n    <td class=\\\"\\\">Boolean that indicates whether the Write Review form should have an input field for the reviewer’s e-mail address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">captcha</td>\\n    <td class=\\\"\\\">reCAPTCHA public key (for validating human versus bot visitors)</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=\\\"\\\">list </td>\\n    <td class=\\\"\\\">List of reviews</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> rating</span></td>\\n    <td class=\\\"\\\">Product’s rating (1–5 stars)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> title</span></td>\\n    <td class=\\\"\\\">Title of the review</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> date</span></td>\\n    <td class=\\\"\\\">Date the product was reviewed</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> text</span></td>\\n    <td class=\\\"\\\">Text content of the product review</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Name of the person providing the review</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"SimByView\\\"></a>Similar Products by Customer Views</h2>\\n\\n<b>Description:</b> A list of products similar to a given product, based on customer’s product browsing history. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/products/tabs.html</span></nobr> partial.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.similar_by_views}}</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=\\\"Videos\\\"></a>Product Videos</h2>\\n\\n<b>Description:</b> A list of videos for a given product. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> template, and on the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/amp/products/product-view.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.videos}}</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=\\\"\\\">ID of the product video</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">title_short</td>\\n    <td class=\\\"\\\">Short title of the product video</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">title_long</td>\\n    <td class=\\\"\\\">Long title of the product video</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">description_long</td>\\n    <td class=\\\"\\\">Long description of the product video</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">description_short</td>\\n    <td class=\\\"\\\">Short description of the product video</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">length</td>\\n    <td class=\\\"\\\">Duration of the product video</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Compare\\\"></a>Compare</h2>\\n\\n<b>Description:</b> Property to display an array of products on product comparison pages. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/compare.html</span></nobr> template.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{comparisons}}</span><br>\\n\\n<b>Object Properties:</b> References the  <a href=\\\"/docs/common-product-card-model\\\">product card model</a>, plus the additional fields listed here:<br>\\n\\n <br>\\n\\n<table>\\n  <tr>\\n    <td>Property</td>\\n    <td>Description</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">availability</td>\\n    <td class=\\\"\\\">How long this product usually takes to ship</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">brand</td>\\n    <td class=\\\"\\\">Object containing brand data for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> url</span></td>\\n    <td class=\\\"\\\">Brand URL for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Brand name for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">remove_url</td>\\n    <td class=\\\"\\\">URL to remove this product/column from the comparison</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">custom_fields</td>\\n    <td class=\\\"\\\">Array of additional product details – size, color, book's ISBN, DVD's release date, etc. – as name/value pairs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Displayed name for this custom field</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> value</span></td>\\n    <td class=\\\"\\\">Value for this custom field’s entry</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"DownItem\\\"></a>Download Item</h2>\\n\\n<b>Description:</b> Property for digital (non-physical) products. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/download-item.html</span></nobr> template.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{downloads}}</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=\\\"\\\">order_id</td>\\n    <td class=\\\"\\\">ID for this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">product_name</td>\\n    <td class=\\\"\\\">Name of the digital product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">items</td>\\n    <td class=\\\"\\\">Array of product components</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">name</span></td>\\n    <td class=\\\"\\\">Name of this digital item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">expired</span></td>\\n    <td class=\\\"\\\">Boolean indicating whether customer’s access/subscription to this item has expired</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">days_remaining</span></td>\\n    <td class=\\\"\\\">Number of days left in customer’s access/subscription to this item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">downloads_remaining</span></td>\\n    <td class=\\\"\\\">Number of times customer may download this item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">size</span></td>\\n    <td class=\\\"\\\">File size of this digital item (string, responsively formatted as: 240 KB, 1.1 MB, etc.)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">description</span></td>\\n    <td class=\\\"\\\">Description (if entered by merchant) for this item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">ID for this item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">images</span></td>\\n    <td class=\\\"\\\">List of all images for the product associated with this list of downloadable items (in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a>)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">thumbnail</span></td>\\n    <td class=\\\"\\\">\\\"Primary\\\" image for the product associated with this list of downloadable items (in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a>)</td>\\n  </tr>\\n</table>\\n\\n\\n<!-- <h2> <A NAME=\\\"SimByTag\\\"></a>Similar Products by Tag</h2>\\n\\n<b>Description:</b> Property to display an array of related products, based on the displayed product’s tag(s)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.similar_tags}}</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=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Name of this related product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL for this related product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">product_count</td>\\n    <td class=\\\"\\\">Number of related products to display</td>\\n  </tr>\\n</table> -->\\n\\n\\n<h2> <A NAME=\\\"ProdOtherDetails\\\"></a>Product Other Details</h2>\\n\\n<b>Description:</b> Property to display custom product details (such as a book's ISBN code, a DVD's release date, etc.). (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/products/product-view.html</span></nobr> and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/amp/products/product-view-details.html</span></nobr> partials.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{product.custom_fields}}</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=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Displayed name for this category of information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">value</td>\\n    <td class=\\\"\\\">Displayed value for this product’s entry</td>\\n  </tr>\\n</table>\"\n}\n[/block]","excerpt":"","slug":"product-resources","type":"basic","title":"Product Objects"}
[block:html] { "html": "<a name=\"Stencil-Product-ref\"></a>Product objects map to the products defined by the merchant for their BigCommerce storefront:<br>\n\n<ul>\n <!-- <li><a href=\"/docs/common-product-card-model\n\">Common Product Card Model</a></li> -->\n <li><a href=\"#Product\">Product</a></li>\n <li><a href=\"#RelProd\">Related Products</a></li>\n <li><a href=\"#Stencil-ProdRevu-ref\">Product Reviews</a></li>\n <li><a href=\"#SimByView\">Similar Products by Customer Views</a></li> \n <li><a href=\"#Videos\">Product Videos</a></li>\n <li><a href=\"#Compare\">Compare</a></li>\n <li><a href=\"#DownItem\">Download Item</a></li>\n <!-- <li><a href=\"#SimByTag\">Similar Products by Tag</a></li> -->\n <li><a href=\"#ProdOtherDetails\">Product Other Details</a></li>\n</ul>" } [/block] [block:callout] { "type": "info", "body": "Please also see [Common Objects](/docs/common-object-formats) > [Common Product Card Model](/docs/common-product-card-model), which documents the product object returned in collections.", "title": "Other Product Objects" } [/block] [block:html] { "html": "<!-- \"Common Product Card Model\" moved to \"Common Object Formats\" page: -->\n\n<!-- <h2> \n<a name=\"Stencil-ProdCardObj-ref\"></a>Common Product Card Model </h2>\n\n<b>Description:</b> A model for a product’s basic, primary properties. Typically used for list components that show multiple products, each in its own \"card\" or panel.<br>\n\n<b>Handlebars Expression:</b> [N/A]<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=\"\">ID of the product </td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Name of the product</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL to product detail page for the product</td>\n </tr>\n <tr>\n <td class=\"\">availability</td>\n <td class=\"\">Typical shipping time for the product; used to populate \"Usually ships within…\" fields</td>\n </tr>\n <tr>\n <td class=\"\">rating</td>\n <td class=\"\">Product’s rating</td>\n </tr>\n <tr>\n <td class=\"\">brand</td>\n <td class=\"\">Brand properties for the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Product’s brand name</td>\n </tr>\n <tr>\n <td class=\"\">add_to_cart_url</td>\n <td class=\"\">URL that adds this product to customer’s cart</td>\n </tr>\n <tr>\n<td class=\"\">price </td>\n <td class=\"\">References the <a href=\"/docs/catalog-price-common-object\">catalog price object</a>, to access price properties in both raw-numeric and formatted/string formats</td>\n </tr>\n <tr>\n <td class=\"\">summary</td>\n <td class=\"\">Summary description of the product</td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\">Default image for the product, in <a href=\"/docs/stencil-image-common-object\">Stencil image object format</a></td>\n </tr>\n <tr>\n <td class=\"\">date_added</td>\n <td class=\"\">Date the product was added to this BigCommerce storefront</td>\n </tr>\n <tr>\n <td class=\"\">pre_order</td>\n <td class=\"\">Product’s availability for pre-order</td>\n </tr>\n <tr>\n <td class=\"\">release_date</td>\n <td class=\"\">Release date, if the product is set to pre-order status</td>\n </tr>\n <tr>\n <td class=\"\">show_cart_action</td>\n <td class=\"\">Boolean that indicates whether the product is available for purchase</td>\n </tr>\n <tr>\n <td class=\"\">has_options</td>\n <td class=\"\">Boolean that indicates whether customer is required to specify options when ordering the product</td>\n </tr>\n <tr>\n <td class=\"\">qty_in_cart</td>\n <td class=\"\">Quantity of this item in the customer’s cart</td>\n </tr>\n <tr>\n <td class=\"\">out_of_stock_message</td>\n <td class=\"\">Text to display when the product is out of stock</td>\n </tr>\n</table> -->\n\n<!-- :\"Common Product Card Model\" moved to \"Common Object Formats\" page -->\n\n\n<h2> <A NAME=\"Product\"></a>Product</h2>\n\n<b>Description:</b> Default property that provides detailed product data. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/amp/product.html</span></nobr> templates, and on several partials in the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: <br>\n<NOBR><span class=\"inline-code\">account/returns-list.html</span></nobr>, \n<NOBR><span class=\"inline-code\">cart/item-options.html</span></nobr>, \n<NOBR><span class=\"inline-code\">products/add-to-cart.html</span></nobr>, \n<NOBR><span class=\"inline-code\">products/event-date.html</span></nobr>, \n<NOBR><span class=\"inline-code\">products/modals/writeReview.html</span></nobr>, \n<NOBR><span class=\"inline-code\">products/price.html</span></nobr>, <NOBR><span class=\"inline-code\">products/product-view.html</span></nobr>,\n<NOBR><span class=\"inline-code\">amp/products/product-options.html</span></nobr>, \n<NOBR><span class=\"inline-code\">amp/products/product-view.html</span></nobr>, and \n<NOBR><span class=\"inline-code\">amp/products/product-view-details.html</span></nobr>.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product}}</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 product</td>\n </tr>\n <tr>\n <td class=\"\">sku</td>\n <td class=\"\">Default product variant when no options are selected</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL to the product detail page</td>\n </tr>\n <tr>\n <td class=\"\">upc</td>\n <td class=\"\">Optional UPC code for the product</td>\n </tr>\n <tr>\n <td class=\"\">title</td>\n <td class=\"\">Displayed name of the product</td>\n </tr>\n <tr>\n <td class=\"\">description</td>\n <td class=\"\">(HTML) description of the product</td>\n </tr>\n <tr>\n <td class=\"\">detail_messages</td>\n <td class=\"\">Status messages for display at the top of the product page</td>\n </tr>\n <tr>\n <td class=\"\">min_purchase_quantity</td>\n <td class=\"\">Minimum quantity that can be purchased at once</td>\n </tr>\n <tr>\n <td class=\"\">max_purchase_quantity</td>\n <td class=\"\">Maximum quantity that can be purchased at once</td>\n </tr>\n <tr>\n <td class=\"\">can_purchase</td>\n <td class=\"\">Boolean that indicates whether the product is available for purchase</td>\n </tr>\n <tr>\n <td class=\"\">out_of_stock</td>\n <td class=\"\">Boolean that indicates whether the product is out of stock</td>\n </tr>\n <tr>\n <td class=\"\">out_of_stock_message</td>\n <td class=\"\">Merchant-defined label to display when a product is out of stock</td>\n </tr>\n <tr>\n <td class=\"\">cart_url</td>\n <td class=\"\">URL to the customer’s shopping cart</td>\n </tr>\n <tr>\n <td class=\"\">add_to_wishlist_url</td>\n <td class=\"\">URL to add the product to the customer’s wishlist</td>\n </tr>\n <tr>\n <td class=\"\"><a name=\"customizations\"></a> customizations </td>\n <td class=\"\">Product customizations (for example, a T-shirt size); these correspond to <NOBR><a href=\"https://support.bigcommerce.com/articles/Public/What-are-configurable-fields-and-how-do-I-create-them\">configurable fields</a></nobr> and <a href=\"https://support.bigcommerce.com/articles/Public/Product-Options-Text-Fields#numbers\">numeric-text</a> <a href=\"https://support.bigcommerce.com/articles/Public/Adding-Product-Options\">product options</a> in the BigCommerce control panel</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">Customization ID</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">display_name</span></td>\n <td class=\"\">Label for this customization, as displayed to customers</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">type</span></td>\n <td class=\"\">Customization type [<span class=\"inline-code\">text</span>|<span class=\"inline-code\">textarea</span>|<span class=\"inline-code\">NumbersOnlyText</span>|<span class=\"inline-code\">checkbox</span>|<span class=\"inline-code\">select</span>|<span class=\"inline-code\">file</span>]</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">required</span></td>\n <td class=\"\">Boolean value that indicates whether customer must specify this customization in order to buy the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">condition</span></td>\n <td class=\"\">Boolean value indicating whether to display this product's condition (new, used, or refurbished)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">prefill</span></td>\n <td class=\"\">Optional string value to prefill this field</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">&lt;values&gt;</span></td>\n <td class=\"\">For <span class=\"inline-code\">select</span> type, array of strings listing the available options</td>\n </tr>\n <tr>\n <td class=\"\">\n <!-- <span class=\"inline-code\">&lt;textarea</span>=\"\"> -->\n <span class=\"indent1\">&lt;file_types&gt;</span></td>\n <td class=\"\">For <span class=\"inline-code\">file</span> type, string representing the types of allowed files</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">&lt;file_size&gt;</span></td>\n <td class=\"\">For <span class=\"inline-code\">file</span> type, string representing the maximum file size allowed</td>\n </tr>\n \n<!-- Inserted new properties here for NumbersOnlyText type, MERC-159: -->\n <tr>\n <td class=\"\"><span class=\"indent1\">integer_only</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type, boolean value indicating whether to restrict customer's entries to whole numbers only</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">default</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type, optional string representing a default number that customers can see and overwrite</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">limit_input</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type, boolean indicating whether to impose any limits on the numeric values that customers can enter as strings</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">limit_input_option</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type and <span class=\"inline-code\">limit_input</span> = <span class=\"inline-code\">true</span>, the type of limit: <span class=\"inline-code\">lowest</span> or <span class=\"inline-code\">highest</span></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">lowest</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type and <span class=\"inline-code\">limit_input</span> = <span class=\"inline-code\">true</span>, minimum allowable value; a value of <span class=\"inline-code\">0</span> imposes no limit</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">highest</span></td>\n <td class=\"\">For <span class=\"inline-code\">NumbersOnlyText</span> type and <span class=\"inline-code\">limit_input</span> = <span class=\"inline-code\">true</span>, maximum allowable value; a value of <span class=\"inline-code\">0</span> imposes no limit</td>\n </tr>\n<!-- End of customizations child object -->\n \n<!-- Inserted new child object here for swatches, MERC-81: -->\n <tr>\n <td class=\"\"><a name=\"swatch_options\"></a>options</td>\n <td class=\"\">Options for color and pattern swatches displayed for this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">Product ID</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">type</span></td>\n <td class=\"\">String indicating size, color, swatch, etc.</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">display_name</span></td>\n <td class=\"\">Option Name displayed in control panel for this option</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">required</span></td>\n <td class=\"\">Boolean value that indicates whether customer must specify this option in order to buy the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">condition</span></td>\n <td class=\"\">Boolean value indicating whether to display this product's condition (new, used, or refurbished)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">values</span></td>\n <td class=\"\">Array of data (color) or image (pattern) values</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">label</span></td>\n <td class=\"\">Internal label for this value (not normally displayed to shoppers)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">id</span></td>\n <td class=\"\">ID for this value, unique within this values array</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">selected</span></td>\n <td class=\"\">Boolean indicating whether this value is preselected as the option's default value, upon page load</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">data</span></td>\n <td class=\"\">Each <span class=\"inline-code\">values</span> member can contain either a <span class=\"inline-code\">data</span> or an <span class=\"inline-code\">image</span> member; <span class=\"inline-code\">data</span> denotes a color</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\">&lt;color value&gt;</span></td>\n <td class=\"\">Hex code for this color</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">image</span></td>\n <td class=\"\">\n Each <span class=\"inline-code\">values</span> member can contain either a <span class=\"inline-code\">data</span> or an <span class=\"inline-code\">image</span> member; <span class=\"inline-code\">image</span> denotes a pattern, in <a href=\"/docs/stencil-image-common-object\">Stencil image object format</a>. (Note: This <span class=\"inline-code\">image</span> value replaces the <span class=\"inline-code\">{{pattern}}</span> property, which was limited to 18 x 18 pixels, and will be deprecated.)</td>\n </tr>\n<!-- ^ Inserted new object above for swatches, https://jira.bigcommerce.com/browse/MERC-81 -->\n \n <tr>\n <td class=\"\"><a name=\"price\"></a> price </td>\n <td class=\"\">References the <a href=\"/docs/catalog-price-common-object\">catalog price object</a>, to access the product’s price</td>\n </tr>\n <tr>\n <td class=\"\">weight</td>\n <td class=\"\">Weight of the default variant</td>\n </tr>\n <tr>\n <td class=\"\">height</td>\n <td class=\"\">Height of the default variant</td>\n </tr>\n <tr>\n <td class=\"\">width</td>\n <td class=\"\">Width of the default variant</td>\n </tr>\n <tr>\n <td class=\"\">depth</td>\n <td class=\"\">Depth of the default variant</td>\n </tr>\n <tr>\n <td class=\"\">rating</td>\n <td class=\"\">Rating for the product</td>\n </tr>\n <tr>\n <td class=\"\">num_reviews</td>\n <td class=\"\">Number of reviews the product has</td>\n </tr>\n <tr>\n <td class=\"\">bulk_discount_rates </td>\n <td class=\"\">List of discount rates for the current product</td>\n </tr>\n <tr>\n <td class=\"\">condition</td>\n <td class=\"\">Condition of the product</td>\n </tr>\n <tr>\n <td class=\"\">stock_level</td>\n <td class=\"\">Current stock level of the product; will be null if storefront stock display is disabled by the merchant, or if the product lacks inventory tracking</td>\n </tr>\n <tr>\n <td class=\"\">shipping</td>\n <td class=\"\">Shipping properties for the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> fixed</span></td>\n <td class=\"\">Boolean that indicates whether the product’s shipping price is fixed</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> price</span></td>\n <td class=\"\"><a href=\"https://stencil.bigcommerce.com/docs/price-common-object\">Price object</a> that defines the shipping cost for this product (if shipping cost is fixed)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> calculated</span></td>\n <td class=\"\">Boolean that indicates whether the product’s shipping price is calculated at checkout</td>\n </tr>\n <tr>\n <td class=\"\">stock_label</td>\n <td class=\"\">Shows whether the product stock level is for on-hand merchandise or pre-orders.</td>\n </tr>\n <tr>\n <td class=\"\">availability</td>\n <td class=\"\">Optional availability message set by the merchant</td>\n </tr>\n <tr>\n <td class=\"\">pre_order</td>\n <td class=\"\">Availability of the product for pre-order</td>\n </tr>\n <tr>\n <td class=\"\">release_date</td>\n <td class=\"\">Release date, if the product is set to pre-order status</td>\n </tr>\n <tr>\n <td class=\"\">error_message</td>\n <td class=\"\">Potential error on the page (e.g.: out of stock, form validations)</td>\n </tr>\n <tr>\n <td class=\"\">gift_wrapping</td>\n <td class=\"\">Whether or not gift wrapping is enabled</td>\n </tr>\n <tr>\n <td class=\"\">brand</td>\n <td class=\"\">Brand of the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Displayed name of the brand</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> url</span></td>\n <td class=\"\">URL to the brand page</td>\n </tr>\n <tr>\n <td class=\"\">main_image</td>\n <td class=\"\">Primary image to display when the product details page loads</td>\n </tr>\n <tr>\n <td class=\"\">images</td>\n <td class=\"\">List of all images for this product, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a> (as configured in config.json; used with the <span class=\"inline-code\"><a href=\"/docs/handlebars-helpers-reference#image\">getImage</a></span> Handlebars helper)</td>\n </tr>\n <tr>\n <td class=\"\">pinterest_js</td>\n <td class=\"\">Property to display Pinterest button</td>\n </tr>\n <tr>\n <td class=\"\">facebook_like</td>\n <td class=\"\">Property to display Facebook Like button</td>\n </tr>\n <tr>\n <td class=\"\">warranty</td>\n <td class=\"\">Optional warranty text set by the merchant</td>\n </tr>\n <tr>\n <td class=\"\">search_keywords</td>\n <td class=\"\">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 </td>\n </tr>\n\n <tr>\n <td class=\"\">tags</td>\n <td class=\"\">Keywords by which this product can also be identified</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Name of the tag</td>\n </tr>\n \n <tr>\n <td class=\"\">custom_fields </td>\n <td class=\"\">Extra details to display about the product </td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Custom field name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> value</span></td>\n <td class=\"\">Custom field value</td>\n </tr>\n <tr>\n <td class=\"\">event_date</td>\n <td class=\"\">Property to handle a date-based product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Name of the event</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> date_start</span></td>\n <td class=\"\">Event’s start date range</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> date_end</span></td>\n <td class=\"\">Event’s end date range</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> earliest_year</span></td>\n <td class=\"\">Event’s starting year</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> latest_year</span></td>\n <td class=\"\">Event’s ending year</td>\n </tr>\n <td class=\"\"><span class=\"indent1\"> type</span></td>\n <td class=\"\">Type of event</td>\n </tr>\n</table>\n\n<H3><a name=\"ProdOptionsIllus\"></a> {{product.options}} Example </h3>\n\nHere is an illustration of how the <span class=\"inline-code\">{{product.options}}</span> property works. This first image shows a merchant's selection (in the BigCommerce control panel) of an option with display type <span class=\"inline-code\">Swatch</span> and a subtype of <span class=\"inline-code\">Pattern</span>: \n\n<p></p><img src=\"https://files.readme.io/M7gbL8sTTOadKVqA242m_Product-Options~CP.png\" alt=\"Merchant's &ldquo;options &gt; Swatch &gt; Pattern&rdquo; selection in control panel\" height=\"359\" width=\"750\">\n\n<p></p>This second image shows the corresponding JSON (from Stencil's <a href=\"/docs/testingdebugging-themes\">debug</a> panel) rendered in the page context: <NOBR>The <span class=\"inline-code\">image</span></nobr> property will contain a URL, whose referenced image can be scaled as large as 150 x 150 pixels.\n\n<p></p><img src=\"https://files.readme.io/qAw6mOZQQJezOmX2Q5Qy_Product-Options~debug.JSON.png\" alt=\"Corresponding JSON rendered in page context\" height=\"278\" width=\"750\"><br><br>\n\n\n<h2> <A NAME=\"RelProd\"></a>Related Products</h2>\n\n<b>Description:</b> A list of products related to this product. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/products/tabs.html</span></nobr> partial.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.related_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=\"Stencil-ProdRevu-ref\"></a>Product Reviews </h2>\n\n<b>Description:</b> A list of reviews related to this product. When filtering/limiting, reviews' default sorting is by review id, from lowest to highest. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> template, and on several partials in the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/</span></nobr> subdirectory: \n<NOBR><span class=\"inline-code\">products/product-view.html</span></nobr>, \n<NOBR><span class=\"inline-code\">products/modals/writeReview.html</span></nobr>, and \n<NOBR><span class=\"inline-code\">amp/products/product-view.html</span></nobr>.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.reviews}}</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=\"\">start</td>\n <td class=\"\">The review that starts the current page of reviews</td>\n </tr>\n <tr>\n <td class=\"\">total</td>\n <td class=\"\">Total number of reviews</td>\n </tr>\n <tr>\n <td class=\"\">end</td>\n <td class=\"\">Last review on this page</td>\n </tr>\n <tr>\n <td class=\"\">show_review_email</td>\n <td class=\"\">Boolean that indicates whether the Write Review form should have an input field for the reviewer’s e-mail address</td>\n </tr>\n <tr>\n <td class=\"\">captcha</td>\n <td class=\"\">reCAPTCHA public key (for validating human versus bot visitors)</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=\"\">list </td>\n <td class=\"\">List of reviews</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> rating</span></td>\n <td class=\"\">Product’s rating (1–5 stars)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> title</span></td>\n <td class=\"\">Title of the review</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> date</span></td>\n <td class=\"\">Date the product was reviewed</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> text</span></td>\n <td class=\"\">Text content of the product review</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Name of the person providing the review</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"SimByView\"></a>Similar Products by Customer Views</h2>\n\n<b>Description:</b> A list of products similar to a given product, based on customer’s product browsing history. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/products/tabs.html</span></nobr> partial.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.similar_by_views}}</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=\"Videos\"></a>Product Videos</h2>\n\n<b>Description:</b> A list of videos for a given product. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/product.html</span></nobr> template, and on the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/amp/products/product-view.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.videos}}</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=\"\">ID of the product video</td>\n </tr>\n <tr>\n <td class=\"\">title_short</td>\n <td class=\"\">Short title of the product video</td>\n </tr>\n <tr>\n <td class=\"\">title_long</td>\n <td class=\"\">Long title of the product video</td>\n </tr>\n <tr>\n <td class=\"\">description_long</td>\n <td class=\"\">Long description of the product video</td>\n </tr>\n <tr>\n <td class=\"\">description_short</td>\n <td class=\"\">Short description of the product video</td>\n </tr>\n <tr>\n <td class=\"\">length</td>\n <td class=\"\">Duration of the product video</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Compare\"></a>Compare</h2>\n\n<b>Description:</b> Property to display an array of products on product comparison pages. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/compare.html</span></nobr> template.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{comparisons}}</span><br>\n\n<b>Object Properties:</b> References the <a href=\"/docs/common-product-card-model\">product card model</a>, plus the additional fields listed here:<br>\n\n <br>\n\n<table>\n <tr>\n <td>Property</td>\n <td>Description</td>\n </tr>\n <tr>\n <td class=\"\">availability</td>\n <td class=\"\">How long this product usually takes to ship</td>\n </tr>\n <tr>\n <td class=\"\">brand</td>\n <td class=\"\">Object containing brand data for this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> url</span></td>\n <td class=\"\">Brand URL for this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Brand name for this product</td>\n </tr>\n <tr>\n <td class=\"\">remove_url</td>\n <td class=\"\">URL to remove this product/column from the comparison</td>\n </tr>\n <tr>\n <td class=\"\">custom_fields</td>\n <td class=\"\">Array of additional product details – size, color, book's ISBN, DVD's release date, etc. – as name/value pairs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Displayed name for this custom field</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> value</span></td>\n <td class=\"\">Value for this custom field’s entry</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"DownItem\"></a>Download Item</h2>\n\n<b>Description:</b> Property for digital (non-physical) products. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/download-item.html</span></nobr> template.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{downloads}}</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=\"\">order_id</td>\n <td class=\"\">ID for this order</td>\n </tr>\n <tr>\n <td class=\"\">product_name</td>\n <td class=\"\">Name of the digital product</td>\n </tr>\n <tr>\n <td class=\"\">items</td>\n <td class=\"\">Array of product components</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">name</span></td>\n <td class=\"\">Name of this digital item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">expired</span></td>\n <td class=\"\">Boolean indicating whether customer’s access/subscription to this item has expired</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">days_remaining</span></td>\n <td class=\"\">Number of days left in customer’s access/subscription to this item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">downloads_remaining</span></td>\n <td class=\"\">Number of times customer may download this item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">size</span></td>\n <td class=\"\">File size of this digital item (string, responsively formatted as: 240 KB, 1.1 MB, etc.)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">description</span></td>\n <td class=\"\">Description (if entered by merchant) for this item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">ID for this item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">images</span></td>\n <td class=\"\">List of all images for the product associated with this list of downloadable items (in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a>)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">thumbnail</span></td>\n <td class=\"\">\"Primary\" image for the product associated with this list of downloadable items (in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a>)</td>\n </tr>\n</table>\n\n\n<!-- <h2> <A NAME=\"SimByTag\"></a>Similar Products by Tag</h2>\n\n<b>Description:</b> Property to display an array of related products, based on the displayed product’s tag(s)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.similar_tags}}</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=\"\">name</td>\n <td class=\"\">Name of this related product</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL for this related product</td>\n </tr>\n <tr>\n <td class=\"\">product_count</td>\n <td class=\"\">Number of related products to display</td>\n </tr>\n</table> -->\n\n\n<h2> <A NAME=\"ProdOtherDetails\"></a>Product Other Details</h2>\n\n<b>Description:</b> Property to display custom product details (such as a book's ISBN code, a DVD's release date, etc.). (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/products/product-view.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/amp/products/product-view-details.html</span></nobr> partials.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{product.custom_fields}}</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=\"\">name</td>\n <td class=\"\">Displayed name for this category of information</td>\n </tr>\n <tr>\n <td class=\"\">value</td>\n <td class=\"\">Displayed value for this product’s entry</td>\n </tr>\n</table>" } [/block]