{"_id":"5833aaf67b7c390f00a7d573","parentDoc":null,"project":"55a6e72e8cc73e0d00096635","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"},"user":"55a6caa022cfa321008e01d6","version":{"_id":"55a6e72f8cc73e0d00096638","project":"55a6e72e8cc73e0d00096635","hasReference":false,"__v":29,"hasDoc":true,"createdAt":"2015-07-15T23:05:19.125Z","releaseDate":"2015-07-15T23:05:19.125Z","categories":["55a6e7308cc73e0d00096639","55b7ed07aea7c8190058badb","5604567c0c78b00d0039b191","5605e6f23a93940d002b3e4a","5605f2bba4574a0d00811365","5605f309a4574a0d00811366","5608e3b98aedf50d0004cf8f","5608e4318aedf50d0004cf90","5608e6b5a7cc2f0d00d9754d","5608e6d331beb60d001b6560","5608f879a7cc2f0d00d97580","560b097887b71d0d000d3bd9","560b13cbafa0990d00979545","560b5cbec341310d00de2a01","560b5cd0c341310d00de2a02","566a35b81e08750d00a0c49b","566a3e8503b4b20d00d02a4a","567889d307bf6a0d0083edc8","569c8b7c15bb390d00db6f9d","56b254dc65ddf50d0076ba8f","57a8ebc4cdeea20e001d2a63","57e48a4000c8680e00fae6e7","5808216773557d0f00a1e428","58105ad54a8aa50f00aa4cba","58105bf298aea40f00afa3ba","58105f548a4aed0f00d67536","581061b898aea40f00afa3be","584b3de7e5f3a42300df6ef7","596839a75965d400155bb750"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-22T02:18:30.064Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":29,"body":"[block:html]\n{\n  \"html\": \"<!-- Moved from \\\"Product Objects\\\" page: -->\\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><p></p>\\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=\\\"\\\">sku</td>\\n    <td class=\\\"\\\">The product's SKU (stock keeping unit)/product code, as a string; if the SKU field is not populated, then null\\n </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=\\\"\\\">ratings</td>\\n    <td class=\\\"\\\">Number of reviews on which the rating is based</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 format</a> <!-- <a href=\\\"/docs/handlebars-image-helpers\\\">Stencil image format</a> --> </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">images</td>\\n    <td class=\\\"\\\">Array of a product's images, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a>; currently limited to 5 images </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  \\n  <tr>\\n    <td class=\\\"\\\">stock_level</td>\\n    <td class=\\\"\\\">If inventory tracking is turned on: The number of items available for sale (0 or more). If inventory tracking is turned off: A \\\"null\\\" string. </td>\\n  </tr>\\n     \\n  <tr>\\n    <td class=\\\"\\\">low_ stock_level</td>\\n    <td class=\\\"\\\">If inventory tracking is turned on: Sets a threshold low-stock level. You can use conditional logic to display a \\\"limited availability\\\" badge if the <span class=\\\"inline-code\\\">stock_level</span> property's value falls below this threshold. If inventory tracking is turned off: A \\\"null\\\" string. </td>\\n  </tr>\\n   \\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  \\n  <tr>\\n    <td class=\\\"\\\">custom_fields</td>\\n    <td class=\\\"\\\">Array of <a href=\\\"https://support.bigcommerce.com/articles/Public/Custom-Fields\\\">custom fields</a> for this product; custom fields can be used for purposes like: alternate brand name, merchandising title for the product, product type, \\\"gift idea\\\" indicator, etc.\\n</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> id </span></td>\\n    <td class=\\\"\\\">Unique (integer) identifier for this custom field</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name </span></td>\\n    <td class=\\\"\\\">Name of this custom field</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> value </span></td>\\n    <td class=\\\"\\\">Value for this custom field</td>\\n  </tr>\\n    \\n</table>\\n\\n<b>Available through:</b> <br><p></p>\\n\\n<b>Object:</b> <span class=\\\"inline-code\\\"> {{comparisons}} </span> <br><p></p>\\n\\n<b>Arrays/Elements:</b> <span class=\\\"inline-code\\\">{{product.related_products}}, {{product.similar_by_views}}, {{category.products}}, {{cart.suggested_products}}, {{customer.recently_viewed_products}} </span><br><p></p>\\n\\n<!-- :\\\"Common Product Card Model\\\" moved from \\\"Product Objects\\\" page -->\"\n}\n[/block]","excerpt":"","slug":"common-product-card-model","type":"basic","title":"Common Product Card Model"}

Common Product Card Model


[block:html] { "html": "<!-- Moved from \"Product Objects\" page: -->\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><p></p>\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=\"\">sku</td>\n <td class=\"\">The product's SKU (stock keeping unit)/product code, as a string; if the SKU field is not populated, then null\n </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=\"\">ratings</td>\n <td class=\"\">Number of reviews on which the rating is based</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 format</a> <!-- <a href=\"/docs/handlebars-image-helpers\">Stencil image format</a> --> </td>\n </tr>\n <tr>\n <td class=\"\">images</td>\n <td class=\"\">Array of a product's images, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a>; currently limited to 5 images </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 \n <tr>\n <td class=\"\">stock_level</td>\n <td class=\"\">If inventory tracking is turned on: The number of items available for sale (0 or more). If inventory tracking is turned off: A \"null\" string. </td>\n </tr>\n \n <tr>\n <td class=\"\">low_ stock_level</td>\n <td class=\"\">If inventory tracking is turned on: Sets a threshold low-stock level. You can use conditional logic to display a \"limited availability\" badge if the <span class=\"inline-code\">stock_level</span> property's value falls below this threshold. If inventory tracking is turned off: A \"null\" string. </td>\n </tr>\n \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 \n <tr>\n <td class=\"\">custom_fields</td>\n <td class=\"\">Array of <a href=\"https://support.bigcommerce.com/articles/Public/Custom-Fields\">custom fields</a> for this product; custom fields can be used for purposes like: alternate brand name, merchandising title for the product, product type, \"gift idea\" indicator, etc.\n</td>\n </tr>\n\n <tr>\n <td class=\"\"><span class=\"indent1\"> id </span></td>\n <td class=\"\">Unique (integer) identifier for this custom field</td>\n </tr>\n\n <tr>\n <td class=\"\"><span class=\"indent1\"> name </span></td>\n <td class=\"\">Name of this custom field</td>\n </tr>\n\n <tr>\n <td class=\"\"><span class=\"indent1\"> value </span></td>\n <td class=\"\">Value for this custom field</td>\n </tr>\n \n</table>\n\n<b>Available through:</b> <br><p></p>\n\n<b>Object:</b> <span class=\"inline-code\"> {{comparisons}} </span> <br><p></p>\n\n<b>Arrays/Elements:</b> <span class=\"inline-code\">{{product.related_products}}, {{product.similar_by_views}}, {{category.products}}, {{cart.suggested_products}}, {{customer.recently_viewed_products}} </span><br><p></p>\n\n<!-- :\"Common Product Card Model\" moved from \"Product Objects\" page -->" } [/block]