{"_id":"560ae8b7ee8a910d0072f899","category":{"_id":"5808216773557d0f00a1e428","version":"55a6e72f8cc73e0d00096638","__v":0,"project":"55a6e72e8cc73e0d00096635","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-10-20T01:44:07.096Z","from_sync":false,"order":10,"slug":"stencil-object-model-reference","title":"Stencil Object Model Reference"},"parentDoc":null,"version":{"_id":"55a6e72f8cc73e0d00096638","project":"55a6e72e8cc73e0d00096635","hasReference":false,"__v":29,"hasDoc":true,"createdAt":"2015-07-15T23:05:19.125Z","releaseDate":"2015-07-15T23:05:19.125Z","categories":["55a6e7308cc73e0d00096639","55b7ed07aea7c8190058badb","5604567c0c78b00d0039b191","5605e6f23a93940d002b3e4a","5605f2bba4574a0d00811365","5605f309a4574a0d00811366","5608e3b98aedf50d0004cf8f","5608e4318aedf50d0004cf90","5608e6b5a7cc2f0d00d9754d","5608e6d331beb60d001b6560","5608f879a7cc2f0d00d97580","560b097887b71d0d000d3bd9","560b13cbafa0990d00979545","560b5cbec341310d00de2a01","560b5cd0c341310d00de2a02","566a35b81e08750d00a0c49b","566a3e8503b4b20d00d02a4a","567889d307bf6a0d0083edc8","569c8b7c15bb390d00db6f9d","56b254dc65ddf50d0076ba8f","57a8ebc4cdeea20e001d2a63","57e48a4000c8680e00fae6e7","5808216773557d0f00a1e428","58105ad54a8aa50f00aa4cba","58105bf298aea40f00afa3ba","58105f548a4aed0f00d67536","581061b898aea40f00afa3be","584b3de7e5f3a42300df6ef7","596839a75965d400155bb750"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":24,"user":"55a6caa022cfa321008e01d6","project":"55a6e72e8cc73e0d00096635","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-29T19:38:31.808Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":35,"body":"[block:html]\n{\n  \"html\": \"<a name=\\\"Stencil-Customer-ref\\\"></a>Customer objects map to customer accounts that have been created by the customer or the merchant:<br>\\n\\n<ul>\\n  <li><a href=\\\"#Customer\\\">Customer</a></li>\\n  <li><a href=\\\"#OrderDet\\\">Order Details</a></li>\\n <li><a href=\\\"#Recent\\\">Recent Items</a></li>\\n <li><a href=\\\"#Wishlists\\\">Customer Wishlists</a></li>\\n <li><a href=\\\"#WishDet\\\">Wishlist Details</a></li>  \\n <li><a href=\\\"#Shipments\\\">Account Order Shipments</a></li>\\n <li><a href=\\\"#Orders\\\">Account Orders</a></li>\\n <li><a href=\\\"#Returns\\\">Account Returns</a></li>\\n <li><a href=\\\"#NewReturn\\\">Account New Return</a></li>\\n <li><a href=\\\"#CreateAccount\\\">Create Account</a></li>\\n <li><a href=\\\"#ShipAddress\\\">Shipping Addresses</a></li>\\n</ul>\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"These objects return customer or order information only when a customer is logged into the storefront. Furthermore, the information's scope is is restricted to that customer.\",\n  \"title\": \"Scope Restrictions\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"<h2> <A NAME=\\\"Customer\\\"></a>Customer</h2>\\n\\n<b>Description:</b> Customer-specific properties for a storefront customer object. When filtering/limiting, customers' default sorting is by customer id, from lowest to highest. (Called 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\\\">page/contact-us-form.html</span></nobr>,\\n<NOBR><span class=\\\"inline-code\\\">common/subscription-form.html</span></nobr>,\\n<NOBR><span class=\\\"inline-code\\\">account/address-list.html</span></nobr>,\\n<NOBR><span class=\\\"inline-code\\\">account/messages-form.html</span></nobr>, and\\n<NOBR><span class=\\\"inline-code\\\">account/wishlist-list.html</span></nobr>.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer}}</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=\\\"\\\">Customer’s ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Customer’s name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">email</td>\\n    <td class=\\\"\\\">Customer’s email address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">phone</td>\\n    <td class=\\\"\\\">Customer’s phone number</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">store_credit</td>\\n    <td class=\\\"\\\">Customer’s store credit</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">customer_group_id</td>\\n    <td class=\\\"\\\">ID of this customer's group</td>\\n  </tr>\\n\\n  <tr>\\n    <td class=\\\"\\\">customer_group_name</td>\\n    <td class=\\\"\\\">Name of this customer's group</td>\\n  </tr>  \\n  \\n  <tr>\\n    <td class=\\\"\\\">num_new_messages</td>\\n    <td class=\\\"\\\">Number of unread messages for this customer</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">num_wishlists</td>\\n    <td class=\\\"\\\">Number of wishlists for this customer</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_address</td>\\n    <td class=\\\"\\\">Shipping address used for the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> id</span></td>\\n    <td class=\\\"\\\">Unique, system-generated ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> first_name</span></td>\\n    <td class=\\\"\\\">Customer’s shipping (first) name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> last_name</span></td>\\n    <td class=\\\"\\\">Customer’s shipping (last) name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> company</span></td>\\n    <td class=\\\"\\\">Customer's shipping company name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> address1</span></td>\\n    <td class=\\\"\\\">Customer's shipping address, first line</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> address2</span></td>\\n    <td class=\\\"\\\">Customer's shipping address, second line</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> city</span></td>\\n    <td class=\\\"\\\">Customer's shipping city</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> state</span></td>\\n    <td class=\\\"\\\">Customer's shipping state</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> zip</span></td>\\n    <td class=\\\"\\\">Customer's shipping zip</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> country</span></td>\\n    <td class=\\\"\\\">Customer's shipping country</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> phone</span></td>\\n    <td class=\\\"\\\">Customer's shipping phone number</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> state_id</span></td>\\n    <td class=\\\"\\\">ID for customer's shipping state/province/region\\n</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> country_id</span></td>\\n    <td class=\\\"\\\">ID for customer's shipping country</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> destination</span></td>\\n    <td class=\\\"\\\">Type of delivery destination: residential or business/commercial</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> last_used</span></td>\\n    <td class=\\\"\\\">Timestamp when this address was last used as a shipping address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> form_session_id</span></td>\\n    <td class=\\\"\\\">Used for custom shipping forms</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"OrderDet\\\"></a>Order Details</h2>\\n\\n<b>Description:</b> The order properties for a specific order, usable on the order details page. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/orders/details.html</span></nobr> and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/orders/invoice.html</span></nobr> templates, and on the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/account/order-contents.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{order}}</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=\\\"\\\">date</td>\\n    <td class=\\\"\\\">Date of the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">id</td>\\n    <td class=\\\"\\\">Unique, system-generated ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">total</td>\\n    <td class=\\\"\\\">Price object that defines the order’s total value</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">status</td>\\n    <td class=\\\"\\\">Order status code</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">status_text</td>\\n    <td class=\\\"\\\">Status text associated with the status code for the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">returns_enabled</td>\\n    <td class=\\\"\\\">Boolean that indicates whether merchant allows products from the order to be returned</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">reorder_url</td>\\n    <td class=\\\"\\\">URL to place reorders for items in this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">invoice_url</td>\\n    <td class=\\\"\\\">URL to display an invoice for this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">is_complete</td>\\n    <td class=\\\"\\\">Boolean indicating that the order has been completed</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">comments</td>\\n    <td class=\\\"\\\">Customer’s message about the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">is_digital</td>\\n    <td class=\\\"\\\">Boolean indicating whether the order will be delivered digitally</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">items</td>\\n    <td class=\\\"\\\">List of items for the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> order_product_id</span></td>\\n    <td class=\\\"\\\">Product ID</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> name</span></td>\\n    <td class=\\\"\\\">Product Name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> quantity</span></td>\\n    <td class=\\\"\\\">Quantity Ordered</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> refunded</span></td>\\n    <td class=\\\"\\\">Price object that defines the value of this product that has been refunded</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> event_date </span></td>\\n    <td class=\\\"\\\">A chosen event date for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> price</span></td>\\n    <td class=\\\"\\\">Price object that defines the product’s price</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">shipping_rows</span></td>\\n    <td class=\\\"\\\">Array of shipping addresses, for each item in the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">address</span></td>\\n    <td class=\\\"\\\">Street address to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">city</span></td>\\n    <td class=\\\"\\\">City to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">state </span></td>\\n    <td class=\\\"\\\">State to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">zip</span></td>\\n    <td class=\\\"\\\">Postal/ZIP code to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">country</span></td>\\n    <td class=\\\"\\\">Country to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> gift_wrapping_name</span></td>\\n    <td class=\\\"\\\">Name of the gift-wrapping option used</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> type</span></td>\\n    <td class=\\\"\\\">Type of purchase; value is one of: physical, digital, giftcertificate</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> download_url</span></td>\\n    <td class=\\\"\\\">URL at which customer can download digital item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> image</span></td>\\n    <td class=\\\"\\\">The image of the order’s first product, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">show_reorder</span>\\n</td>\\n    <td class=\\\"\\\">Boolean indicating whether the customer should see a button for reordering items on the Account Order Details page</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> reorder_message</span></td>\\n    <td class=\\\"\\\">An error message to be displayed when the customer attempts to reorder items that can’t be reordered</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\"> options</span></td>\\n    <td class=\\\"\\\">A list of options selected when this product was purchased</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> name</span></td>\\n    <td class=\\\"\\\">Display name for the option (\\\"Small\\\", “Medium”, etc.)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\"> value</span></td>\\n    <td class=\\\"\\\">Value that customer selected for the option</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">billing_address</td>\\n    <td class=\\\"\\\">Billing address used for the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> full_name</span></td>\\n    <td class=\\\"\\\">Customer's billing name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> company</span></td>\\n    <td class=\\\"\\\">Customer's billing company name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> address_lines</span></td>\\n    <td class=\\\"\\\">Customer's billing address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> city</span></td>\\n    <td class=\\\"\\\">Customer's billing city</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> state</span></td>\\n    <td class=\\\"\\\">Customer's billing state</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> country</span></td>\\n    <td class=\\\"\\\">Customer billing country</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> zip</span></td>\\n    <td class=\\\"\\\">Customer billing ZIP</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> phone</span></td>\\n    <td class=\\\"\\\">Customer billing phone number</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_address_count</td>\\n    <td class=\\\"\\\">Number of shipping addresses the customer has specified for this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_address</td>\\n    <td class=\\\"\\\">Shipping address used for the order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> full_name</span></td>\\n    <td class=\\\"\\\">Customer's shipping name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> company</span></td>\\n    <td class=\\\"\\\">Customer's shipping company name</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> address_lines</span></td>\\n    <td class=\\\"\\\">Customer's shipping address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> city</span></td>\\n    <td class=\\\"\\\">Customer's shipping city</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> state</span></td>\\n    <td class=\\\"\\\">Customer's shipping state</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> country</span></td>\\n    <td class=\\\"\\\">Customer's shipping country</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> zip</span></td>\\n    <td class=\\\"\\\">Customer's shipping zip</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> phone</span></td>\\n    <td class=\\\"\\\">Customer's shipping phone number</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">payment_method</td>\\n    <td class=\\\"\\\">Customer’s payment method for this order (payment gateway)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">card_number_last_four</td>\\n    <td class=\\\"\\\">Last four digits of customer’s credit card</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">total_rows</td>\\n    <td class=\\\"\\\">A list of “total” rows containing total pricing information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> label</span></td>\\n    <td class=\\\"\\\">The label of the total row (Subtotal, Tax, Grand Total, etc.)</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Recent\\\"></a>Recent Items</h2>\\n\\n<b>Description:</b> Items the customer has recently viewed. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/recent-items.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer.recently_viewed_products}}</span><br>\\n\\n<b>Object Properties: </b>References the standard  <a href=\\\"/docs/common-product-card-model\\\">product card model</a>.<br><br>\\n\\n\\n<h2> <A NAME=\\\"Wishlists\\\"></a>Customer Wishlists</h2>\\n\\n<b>Description:</b> Array of product wishlists, specific to this store, for the customer. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/account/wishlist-list.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer.wishlists}}</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 system ID of the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">num_items</td>\\n    <td class=\\\"\\\">Number of items in the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Customer-defined name of the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">is_public</td>\\n    <td class=\\\"\\\">Boolean value indicating whether the wishlist is publicly available </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">is_editable</td>\\n    <td class=\\\"\\\">Boolean indicating whether the \\\"Remove Item\\\" button, and account navigation controls, are displayed (i.e., whether the customer viewing the wishlist is this wishlist’s owner)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">token</td>\\n    <td class=\\\"\\\">Unique public token for the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">view_url</td>\\n    <td class=\\\"\\\">URL to view the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">edit_url</td>\\n    <td class=\\\"\\\">URL to edit the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">delete_url</td>\\n    <td class=\\\"\\\">URL to delete the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">share_url</td>\\n    <td class=\\\"\\\">URL to share the wishlist</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"WishDet\\\"></a>Wishlist Details</h2>\\n\\n<b>Description:</b> Wishlist information for a specific wishlist. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/wishlist-details.html</span></nobr> template and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/account/wishlist-item-list.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{wishlist}}</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 system ID for the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Customer-defined name of the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">is_public</td>\\n    <td class=\\\"\\\">Boolean value indicating whether the wishlist is publicly available </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">token</td>\\n    <td class=\\\"\\\">Unique public token for the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">share_url</td>\\n    <td class=\\\"\\\">URL used to share the wishlist</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">items</td>\\n    <td class=\\\"\\\">List of items in the wishlist; extends the <a href=\\\"/docs/common-product-card-model\\\">product card model</a>, adding the extra properties below:</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> id</span></td>\\n    <td class=\\\"\\\">Unique system ID for this wishlist item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> product_id</span></td>\\n    <td class=\\\"\\\">Product ID for the item</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\"> remove_url</span></td>\\n    <td class=\\\"\\\">URL to remove the product from the wishlist</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Shipments\\\"></a>Account Order Shipments</h2>\\n\\n<b>Description:</b> Objects to manage shipments associated with a specific order details for the current customer. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/orders/details.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{shipments}}</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=\\\"\\\">date_shipped</td>\\n    <td class=\\\"\\\">Shipping date for this shipment</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_provider</td>\\n    <td class=\\\"\\\">Carrier for this shipment</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_method</td>\\n    <td class=\\\"\\\">Shipping method for this shipment</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">show_shipping_method</td>\\n    <td class=\\\"\\\">Boolean indicating whether to display the shipping method to the customer</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">shipping_track</td>\\n    <td class=\\\"\\\">Tracking information for this shipment</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">url</span></td>\\n    <td class=\\\"\\\">Tracking URL for this shipment</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">number</span></td>\\n    <td class=\\\"\\\">Tracking number for this shipment</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Orders\\\"></a>Account Orders</h2>\\n\\n<b>Description:</b> Objects to manage completed orders for the current customer. By default, orders sort by <NOBR>order <span class=\\\"inline-code\\\">id</span></nobr>, from lowest to highest. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/orders/all.html</span></nobr> and <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/orders/completed.html</span></nobr>  templates, and on the <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/account/orders-list.html</span></nobr> partial.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer.orders}}</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=\\\"\\\">pagination</td>\\n    <td class=\\\"\\\">References pagination model</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">date</td>\\n    <td class=\\\"\\\">Date this order was placed</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">last_update_date</td>\\n    <td class=\\\"\\\">Date this order was last updated</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">id</td>\\n    <td class=\\\"\\\">ID for this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">total</td>\\n    <td class=\\\"\\\">Total value of this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">status</td>\\n    <td class=\\\"\\\">Status of this order (\\\"Completed\\\" or other)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">return_url</td>\\n    <td class=\\\"\\\">URL for returning items in this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">reorder_url</td>\\n    <td class=\\\"\\\">URL for reordering items in this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">details_url</td>\\n    <td class=\\\"\\\">URL for details about this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">payment_instructions</td>\\n    <td class=\\\"\\\">Text field defined by merchant as to payment instructions for manual gateways such as “Bank Deposit”</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\">Image of the order’s first product, in <a href=\\\"/docs/stencil-image-common-object\\\">Stencil image format</a></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">items</td>\\n    <td class=\\\"\\\">Array of products in this order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">name</span></td>\\n    <td class=\\\"\\\">Name of this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">quantity</span></td>\\n    <td class=\\\"\\\">Quantity of this product ordered</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">refunded</span></td>\\n    <td class=\\\"\\\">Price object that defines the amount of this product that has been refunded</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">expected_release_date</span></td>\\n    <td class=\\\"\\\">Expected ship date if the product is set to pre-order status</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">type</span></td>\\n    <td class=\\\"\\\">Type of purchase; value is one of: physical, digital, giftcertificate</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">download_url</span></td>\\n    <td class=\\\"\\\">URL for customer to download a digital product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">image</span></td>\\n    <td class=\\\"\\\">The image for this ordered product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">options</span></td>\\n    <td class=\\\"\\\">Array of additional product details (size, color, etc.), as name/value pairs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">name</span></td>\\n    <td class=\\\"\\\">Displayed name for this category of information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent2\\\">value</span></td>\\n    <td class=\\\"\\\">Displayed value for this product’s entry</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"Returns\\\"></a>Account Returns</h2>\\n\\n<b>Description:</b> Objects to manage returns for the current customer. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/returns.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer.returns}}</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=\\\"\\\">date_requested</td>\\n    <td class=\\\"\\\">Date on which the customer requested this return</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">id</td>\\n    <td class=\\\"\\\">The ID for this return</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">quantity</td>\\n    <td class=\\\"\\\">Quantity of items returned</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">reason</td>\\n    <td class=\\\"\\\">Reason for return; merchants can define actions beyond the default strings created with each store, which are: Received Wrong Product, Wrong Product Ordered, Not Satisfied With The Product, and There Was A Problem With The Product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">action</td>\\n    <td class=\\\"\\\">Return action; merchants can define actions beyond the default set created with each store (Repair, Replacement, or Store Credit)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">comments</td>\\n    <td class=\\\"\\\">Comments that the customer entered with the return request</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">status</td>\\n    <td class=\\\"\\\">Status of the return: Pending, Received, Authorized, Repaired, \\nRefunded, Rejected, or Cancelled</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">product</td>\\n    <td class=\\\"\\\">Array of products included in the return</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">url</td>\\n    <td class=\\\"\\\">URL for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">name</td>\\n    <td class=\\\"\\\">Name of this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">options</td>\\n    <td class=\\\"\\\">Array of additional product details (size, color, 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 category of information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">value</span></td>\\n    <td class=\\\"\\\">Displayed value for this product’s entry</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">image</td>\\n    <td class=\\\"\\\">Image for this product</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"NewReturn\\\"></a>Account New Return</h2>\\n\\n<b>Description:</b> Objects to handle a new return for the current customer. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/account/add-return.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{forms.return}}</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 the original order</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">reasons</td>\\n    <td class=\\\"\\\">Reasons for return</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">actions</td>\\n    <td class=\\\"\\\">Return actions: an array of strings arbitrarily defined by the merchant: refund, exchange, credit, etc.</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">order_products</td>\\n    <td class=\\\"\\\">Array of products from the order that are available to return</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">id</span></td>\\n    <td class=\\\"\\\">ID for the product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">name</span></td>\\n    <td class=\\\"\\\">Name of this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">product_id</span></td>\\n    <td class=\\\"\\\">ID for this product</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">price</span></td>\\n    <td class=\\\"\\\">Price object that defines this product’s price</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">quantity</span></td>\\n    <td class=\\\"\\\">Quantity of the product returned</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">options</span></td>\\n    <td class=\\\"\\\">Array of additional product details (size, color, etc.), as name/value pairs</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\">name</span></td>\\n    <td class=\\\"\\\">Displayed name for this category of information</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent3\\\">value</span></td>\\n    <td class=\\\"\\\">Displayed value for this product’s entry</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"CreateAccount\\\"></a>Create Account</h2>\\n\\n<b>Description:</b> Object to enable the current customer to create a store account. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/pages/auth/create-account.html</span></nobr> template.) <br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{forms.create_account}}</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=\\\"\\\">recaptcha</td>\\n    <td class=\\\"\\\">Objects for integrating the Google reCAPTCHA service to distinguish human visitors from ’bots (automated agents)</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">enabled</span></td>\\n    <td class=\\\"\\\">Boolean indicating whether reCAPTCHA is enabled for this store</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">public_key</span></td>\\n    <td class=\\\"\\\">Public key (site key) that reCAPTCHA returns upon merchant’s enabling CAPTCHA security in Store Settings > Display Settings</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">address_fields</td>\\n    <td class=\\\"\\\">Array of form fields that define each shipping address for this customer; for details, see this repo: <NOBR><a href=\\\"https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms\\\">https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms</a></nobr></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">class_name</span></td>\\n    <td class=\\\"\\\">Specifies a CSS class (defined in the theme's <span class=\\\"inline-code\\\">/assets/scss/</span> subdirectory) to apply to a field within the array; for corresponding control-panel steps, see this support article:\\n <NOBR><a href=\\\"https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings\\\">https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings</a> </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">account_fields</td>\\n    <td class=\\\"\\\">Object of form fields; for details, see this repo:\\n <NOBR><a href=\\\"https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms\\\">https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms</a></nobr></td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\"><span class=\\\"indent1\\\">class_name</span></td>\\n    <td class=\\\"\\\">Specifies a CSS class to apply to a field within the array; for corresponding control-panel steps, see:\\n <NOBR><a href=\\\"https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings\\\">https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings</a> </td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">error</td>\\n    <td class=\\\"\\\">BCApp generated message to display when customer’s account creation fails</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">checking_out</td>\\n    <td class=\\\"\\\">Boolean indicating whether customer created the account during a purchase checkout</td>\\n  </tr>\\n</table>\\n\\n\\n<h2> <A NAME=\\\"ShipAddress\\\"></a>Shipping Addresses</h2>\\n\\n<b>Description:</b> Object to enable the customer to enter shipping and contact information. (Called on the default <NOBR><span class=\\\"inline-code\\\">&lt;theme-name&gt;/templates/components/account/address-list.html</span></nobr> partial.)<br>\\n\\n<b>Handlebars Expression:</b> <span class=\\\"inline-code\\\">{{customer.addresses}}</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 for this shipping address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">customer_id</td>\\n    <td class=\\\"\\\">ID for this customer</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">first_name</td>\\n    <td class=\\\"\\\">First name to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">last_name</td>\\n    <td class=\\\"\\\">Last name to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">company</td>\\n    <td class=\\\"\\\">Company name to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">address1</td>\\n    <td class=\\\"\\\">Street (etc.) address, first line</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">address2</td>\\n    <td class=\\\"\\\">Street (etc.) address, second line</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">city</td>\\n    <td class=\\\"\\\">City to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">state</td>\\n    <td class=\\\"\\\">State/province/region to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">zip</td>\\n    <td class=\\\"\\\">Postal/ZIP code to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">country</td>\\n    <td class=\\\"\\\">Country to ship to</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">phone</td>\\n    <td class=\\\"\\\">Addressee’s phone number</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">state_id</td>\\n    <td class=\\\"\\\">ID for destination state/province/region</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">country_id</td>\\n    <td class=\\\"\\\">ID for destination country</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">destination</td>\\n    <td class=\\\"\\\">residential or commercial</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">last_used</td>\\n    <td class=\\\"\\\">Boolean, indicating whether this was the last-used shipping address for this customer</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">full_name</td>\\n    <td class=\\\"\\\">Full name of addressee</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">edit_url</td>\\n    <td class=\\\"\\\">URL for customer to edit this shipping address</td>\\n  </tr>\\n  <tr>\\n    <td class=\\\"\\\">delete_url</td>\\n    <td class=\\\"\\\">URL for customer to delete this shipping address </td>\\n  </tr>\\n</table>\"\n}\n[/block]","excerpt":"","slug":"customer-resources","type":"basic","title":"Customer Objects"}
[block:html] { "html": "<a name=\"Stencil-Customer-ref\"></a>Customer objects map to customer accounts that have been created by the customer or the merchant:<br>\n\n<ul>\n <li><a href=\"#Customer\">Customer</a></li>\n <li><a href=\"#OrderDet\">Order Details</a></li>\n <li><a href=\"#Recent\">Recent Items</a></li>\n <li><a href=\"#Wishlists\">Customer Wishlists</a></li>\n <li><a href=\"#WishDet\">Wishlist Details</a></li> \n <li><a href=\"#Shipments\">Account Order Shipments</a></li>\n <li><a href=\"#Orders\">Account Orders</a></li>\n <li><a href=\"#Returns\">Account Returns</a></li>\n <li><a href=\"#NewReturn\">Account New Return</a></li>\n <li><a href=\"#CreateAccount\">Create Account</a></li>\n <li><a href=\"#ShipAddress\">Shipping Addresses</a></li>\n</ul>" } [/block] [block:callout] { "type": "info", "body": "These objects return customer or order information only when a customer is logged into the storefront. Furthermore, the information's scope is is restricted to that customer.", "title": "Scope Restrictions" } [/block] [block:html] { "html": "<h2> <A NAME=\"Customer\"></a>Customer</h2>\n\n<b>Description:</b> Customer-specific properties for a storefront customer object. When filtering/limiting, customers' default sorting is by customer id, from lowest to highest. (Called 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\">page/contact-us-form.html</span></nobr>,\n<NOBR><span class=\"inline-code\">common/subscription-form.html</span></nobr>,\n<NOBR><span class=\"inline-code\">account/address-list.html</span></nobr>,\n<NOBR><span class=\"inline-code\">account/messages-form.html</span></nobr>, and\n<NOBR><span class=\"inline-code\">account/wishlist-list.html</span></nobr>.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer}}</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=\"\">Customer’s ID</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Customer’s name</td>\n </tr>\n <tr>\n <td class=\"\">email</td>\n <td class=\"\">Customer’s email address</td>\n </tr>\n <tr>\n <td class=\"\">phone</td>\n <td class=\"\">Customer’s phone number</td>\n </tr>\n\n <tr>\n <td class=\"\">store_credit</td>\n <td class=\"\">Customer’s store credit</td>\n </tr>\n\n <tr>\n <td class=\"\">customer_group_id</td>\n <td class=\"\">ID of this customer's group</td>\n </tr>\n\n <tr>\n <td class=\"\">customer_group_name</td>\n <td class=\"\">Name of this customer's group</td>\n </tr> \n \n <tr>\n <td class=\"\">num_new_messages</td>\n <td class=\"\">Number of unread messages for this customer</td>\n </tr>\n <tr>\n <td class=\"\">num_wishlists</td>\n <td class=\"\">Number of wishlists for this customer</td>\n </tr>\n <tr>\n <td class=\"\">shipping_address</td>\n <td class=\"\">Shipping address used for the order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> id</span></td>\n <td class=\"\">Unique, system-generated ID</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> first_name</span></td>\n <td class=\"\">Customer’s shipping (first) name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> last_name</span></td>\n <td class=\"\">Customer’s shipping (last) name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> company</span></td>\n <td class=\"\">Customer's shipping company name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> address1</span></td>\n <td class=\"\">Customer's shipping address, first line</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> address2</span></td>\n <td class=\"\">Customer's shipping address, second line</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> city</span></td>\n <td class=\"\">Customer's shipping city</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> state</span></td>\n <td class=\"\">Customer's shipping state</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> zip</span></td>\n <td class=\"\">Customer's shipping zip</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> country</span></td>\n <td class=\"\">Customer's shipping country</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> phone</span></td>\n <td class=\"\">Customer's shipping phone number</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> state_id</span></td>\n <td class=\"\">ID for customer's shipping state/province/region\n</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> country_id</span></td>\n <td class=\"\">ID for customer's shipping country</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> destination</span></td>\n <td class=\"\">Type of delivery destination: residential or business/commercial</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> last_used</span></td>\n <td class=\"\">Timestamp when this address was last used as a shipping address</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> form_session_id</span></td>\n <td class=\"\">Used for custom shipping forms</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"OrderDet\"></a>Order Details</h2>\n\n<b>Description:</b> The order properties for a specific order, usable on the order details page. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/orders/details.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/orders/invoice.html</span></nobr> templates, and on the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/account/order-contents.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{order}}</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=\"\">date</td>\n <td class=\"\">Date of the order</td>\n </tr>\n <tr>\n <td class=\"\">id</td>\n <td class=\"\">Unique, system-generated ID</td>\n </tr>\n <tr>\n <td class=\"\">total</td>\n <td class=\"\">Price object that defines the order’s total value</td>\n </tr>\n <tr>\n <td class=\"\">status</td>\n <td class=\"\">Order status code</td>\n </tr>\n <tr>\n <td class=\"\">status_text</td>\n <td class=\"\">Status text associated with the status code for the order</td>\n </tr>\n <tr>\n <td class=\"\">returns_enabled</td>\n <td class=\"\">Boolean that indicates whether merchant allows products from the order to be returned</td>\n </tr>\n <tr>\n <td class=\"\">reorder_url</td>\n <td class=\"\">URL to place reorders for items in this order</td>\n </tr>\n <tr>\n <td class=\"\">invoice_url</td>\n <td class=\"\">URL to display an invoice for this order</td>\n </tr>\n <tr>\n <td class=\"\">is_complete</td>\n <td class=\"\">Boolean indicating that the order has been completed</td>\n </tr>\n <tr>\n <td class=\"\">comments</td>\n <td class=\"\">Customer’s message about the order</td>\n </tr>\n <tr>\n <td class=\"\">is_digital</td>\n <td class=\"\">Boolean indicating whether the order will be delivered digitally</td>\n </tr>\n <tr>\n <td class=\"\">items</td>\n <td class=\"\">List of items for the order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> order_product_id</span></td>\n <td class=\"\">Product ID</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> name</span></td>\n <td class=\"\">Product Name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> quantity</span></td>\n <td class=\"\">Quantity Ordered</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> refunded</span></td>\n <td class=\"\">Price object that defines the value of this product that has been refunded</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> event_date </span></td>\n <td class=\"\">A chosen event date for the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> price</span></td>\n <td class=\"\">Price object that defines the product’s price</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">shipping_rows</span></td>\n <td class=\"\">Array of shipping addresses, for each item in the order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">address</span></td>\n <td class=\"\">Street address to ship to</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">city</span></td>\n <td class=\"\">City to ship to</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">state </span></td>\n <td class=\"\">State to ship to</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">zip</span></td>\n <td class=\"\">Postal/ZIP code to ship to</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">country</span></td>\n <td class=\"\">Country to ship to</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> gift_wrapping_name</span></td>\n <td class=\"\">Name of the gift-wrapping option used</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> type</span></td>\n <td class=\"\">Type of purchase; value is one of: physical, digital, giftcertificate</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> download_url</span></td>\n <td class=\"\">URL at which customer can download digital item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> image</span></td>\n <td class=\"\">The image of the order’s first product, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">show_reorder</span>\n</td>\n <td class=\"\">Boolean indicating whether the customer should see a button for reordering items on the Account Order Details page</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> reorder_message</span></td>\n <td class=\"\">An error message to be displayed when the customer attempts to reorder items that can’t be reordered</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\"> options</span></td>\n <td class=\"\">A list of options selected when this product was purchased</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> name</span></td>\n <td class=\"\">Display name for the option (\"Small\", “Medium”, etc.)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\"> value</span></td>\n <td class=\"\">Value that customer selected for the option</td>\n </tr>\n <tr>\n <td class=\"\">billing_address</td>\n <td class=\"\">Billing address used for the order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> full_name</span></td>\n <td class=\"\">Customer's billing name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> company</span></td>\n <td class=\"\">Customer's billing company name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> address_lines</span></td>\n <td class=\"\">Customer's billing address</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> city</span></td>\n <td class=\"\">Customer's billing city</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> state</span></td>\n <td class=\"\">Customer's billing state</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> country</span></td>\n <td class=\"\">Customer billing country</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> zip</span></td>\n <td class=\"\">Customer billing ZIP</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> phone</span></td>\n <td class=\"\">Customer billing phone number</td>\n </tr>\n <tr>\n <td class=\"\">shipping_address_count</td>\n <td class=\"\">Number of shipping addresses the customer has specified for this order</td>\n </tr>\n <tr>\n <td class=\"\">shipping_address</td>\n <td class=\"\">Shipping address used for the order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> full_name</span></td>\n <td class=\"\">Customer's shipping name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> company</span></td>\n <td class=\"\">Customer's shipping company name</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> address_lines</span></td>\n <td class=\"\">Customer's shipping address</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> city</span></td>\n <td class=\"\">Customer's shipping city</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> state</span></td>\n <td class=\"\">Customer's shipping state</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> country</span></td>\n <td class=\"\">Customer's shipping country</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> zip</span></td>\n <td class=\"\">Customer's shipping zip</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> phone</span></td>\n <td class=\"\">Customer's shipping phone number</td>\n </tr>\n <tr>\n <td class=\"\">payment_method</td>\n <td class=\"\">Customer’s payment method for this order (payment gateway)</td>\n </tr>\n <tr>\n <td class=\"\">card_number_last_four</td>\n <td class=\"\">Last four digits of customer’s credit card</td>\n </tr>\n <tr>\n <td class=\"\">total_rows</td>\n <td class=\"\">A list of “total” rows containing total pricing information</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> label</span></td>\n <td class=\"\">The label of the total row (Subtotal, Tax, Grand Total, etc.)</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Recent\"></a>Recent Items</h2>\n\n<b>Description:</b> Items the customer has recently viewed. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/recent-items.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer.recently_viewed_products}}</span><br>\n\n<b>Object Properties: </b>References the standard <a href=\"/docs/common-product-card-model\">product card model</a>.<br><br>\n\n\n<h2> <A NAME=\"Wishlists\"></a>Customer Wishlists</h2>\n\n<b>Description:</b> Array of product wishlists, specific to this store, for the customer. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/account/wishlist-list.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer.wishlists}}</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 system ID of the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">num_items</td>\n <td class=\"\">Number of items in the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Customer-defined name of the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">is_public</td>\n <td class=\"\">Boolean value indicating whether the wishlist is publicly available </td>\n </tr>\n <tr>\n <td class=\"\">is_editable</td>\n <td class=\"\">Boolean indicating whether the \"Remove Item\" button, and account navigation controls, are displayed (i.e., whether the customer viewing the wishlist is this wishlist’s owner)</td>\n </tr>\n <tr>\n <td class=\"\">token</td>\n <td class=\"\">Unique public token for the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">view_url</td>\n <td class=\"\">URL to view the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">edit_url</td>\n <td class=\"\">URL to edit the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">delete_url</td>\n <td class=\"\">URL to delete the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">share_url</td>\n <td class=\"\">URL to share the wishlist</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"WishDet\"></a>Wishlist Details</h2>\n\n<b>Description:</b> Wishlist information for a specific wishlist. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/wishlist-details.html</span></nobr> template and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/account/wishlist-item-list.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{wishlist}}</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 system ID for the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Customer-defined name of the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">is_public</td>\n <td class=\"\">Boolean value indicating whether the wishlist is publicly available </td>\n </tr>\n <tr>\n <td class=\"\">token</td>\n <td class=\"\">Unique public token for the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">share_url</td>\n <td class=\"\">URL used to share the wishlist</td>\n </tr>\n <tr>\n <td class=\"\">items</td>\n <td class=\"\">List of items in the wishlist; extends the <a href=\"/docs/common-product-card-model\">product card model</a>, adding the extra properties below:</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> id</span></td>\n <td class=\"\">Unique system ID for this wishlist item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> product_id</span></td>\n <td class=\"\">Product ID for the item</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\"> remove_url</span></td>\n <td class=\"\">URL to remove the product from the wishlist</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Shipments\"></a>Account Order Shipments</h2>\n\n<b>Description:</b> Objects to manage shipments associated with a specific order details for the current customer. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/orders/details.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{shipments}}</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=\"\">date_shipped</td>\n <td class=\"\">Shipping date for this shipment</td>\n </tr>\n <tr>\n <td class=\"\">shipping_provider</td>\n <td class=\"\">Carrier for this shipment</td>\n </tr>\n <tr>\n <td class=\"\">shipping_method</td>\n <td class=\"\">Shipping method for this shipment</td>\n </tr>\n <tr>\n <td class=\"\">show_shipping_method</td>\n <td class=\"\">Boolean indicating whether to display the shipping method to the customer</td>\n </tr>\n <tr>\n <td class=\"\">shipping_track</td>\n <td class=\"\">Tracking information for this shipment</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">url</span></td>\n <td class=\"\">Tracking URL for this shipment</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">number</span></td>\n <td class=\"\">Tracking number for this shipment</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Orders\"></a>Account Orders</h2>\n\n<b>Description:</b> Objects to manage completed orders for the current customer. By default, orders sort by <NOBR>order <span class=\"inline-code\">id</span></nobr>, from lowest to highest. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/orders/all.html</span></nobr> and <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/orders/completed.html</span></nobr> templates, and on the <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/account/orders-list.html</span></nobr> partial.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer.orders}}</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=\"\">pagination</td>\n <td class=\"\">References pagination model</td>\n </tr>\n <tr>\n <td class=\"\">date</td>\n <td class=\"\">Date this order was placed</td>\n </tr>\n <tr>\n <td class=\"\">last_update_date</td>\n <td class=\"\">Date this order was last updated</td>\n </tr>\n <tr>\n <td class=\"\">id</td>\n <td class=\"\">ID for this order</td>\n </tr>\n <tr>\n <td class=\"\">total</td>\n <td class=\"\">Total value of this order</td>\n </tr>\n <tr>\n <td class=\"\">status</td>\n <td class=\"\">Status of this order (\"Completed\" or other)</td>\n </tr>\n <tr>\n <td class=\"\">return_url</td>\n <td class=\"\">URL for returning items in this order</td>\n </tr>\n <tr>\n <td class=\"\">reorder_url</td>\n <td class=\"\">URL for reordering items in this order</td>\n </tr>\n <tr>\n <td class=\"\">details_url</td>\n <td class=\"\">URL for details about this order</td>\n </tr>\n <tr>\n <td class=\"\">payment_instructions</td>\n <td class=\"\">Text field defined by merchant as to payment instructions for manual gateways such as “Bank Deposit”</td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\">Image of the order’s first product, in <a href=\"/docs/stencil-image-common-object\">Stencil image format</a></td>\n </tr>\n <tr>\n <td class=\"\">items</td>\n <td class=\"\">Array of products in this order</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">name</span></td>\n <td class=\"\">Name of this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">quantity</span></td>\n <td class=\"\">Quantity of this product ordered</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">refunded</span></td>\n <td class=\"\">Price object that defines the amount of this product that has been refunded</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">expected_release_date</span></td>\n <td class=\"\">Expected ship date if the product is set to pre-order status</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">type</span></td>\n <td class=\"\">Type of purchase; value is one of: physical, digital, giftcertificate</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">download_url</span></td>\n <td class=\"\">URL for customer to download a digital product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">image</span></td>\n <td class=\"\">The image for this ordered product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">options</span></td>\n <td class=\"\">Array of additional product details (size, color, etc.), as name/value pairs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">name</span></td>\n <td class=\"\">Displayed name for this category of information</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent2\">value</span></td>\n <td class=\"\">Displayed value for this product’s entry</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"Returns\"></a>Account Returns</h2>\n\n<b>Description:</b> Objects to manage returns for the current customer. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/returns.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer.returns}}</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=\"\">date_requested</td>\n <td class=\"\">Date on which the customer requested this return</td>\n </tr>\n <tr>\n <td class=\"\">id</td>\n <td class=\"\">The ID for this return</td>\n </tr>\n <tr>\n <td class=\"\">quantity</td>\n <td class=\"\">Quantity of items returned</td>\n </tr>\n <tr>\n <td class=\"\">reason</td>\n <td class=\"\">Reason for return; merchants can define actions beyond the default strings created with each store, which are: Received Wrong Product, Wrong Product Ordered, Not Satisfied With The Product, and There Was A Problem With The Product</td>\n </tr>\n <tr>\n <td class=\"\">action</td>\n <td class=\"\">Return action; merchants can define actions beyond the default set created with each store (Repair, Replacement, or Store Credit)</td>\n </tr>\n <tr>\n <td class=\"\">comments</td>\n <td class=\"\">Comments that the customer entered with the return request</td>\n </tr>\n <tr>\n <td class=\"\">status</td>\n <td class=\"\">Status of the return: Pending, Received, Authorized, Repaired, \nRefunded, Rejected, or Cancelled</td>\n </tr>\n <tr>\n <td class=\"\">product</td>\n <td class=\"\">Array of products included in the return</td>\n </tr>\n <tr>\n <td class=\"\">url</td>\n <td class=\"\">URL for this product</td>\n </tr>\n <tr>\n <td class=\"\">name</td>\n <td class=\"\">Name of this product</td>\n </tr>\n <tr>\n <td class=\"\">options</td>\n <td class=\"\">Array of additional product details (size, color, 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 category of information</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">value</span></td>\n <td class=\"\">Displayed value for this product’s entry</td>\n </tr>\n <tr>\n <td class=\"\">image</td>\n <td class=\"\">Image for this product</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"NewReturn\"></a>Account New Return</h2>\n\n<b>Description:</b> Objects to handle a new return for the current customer. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/account/add-return.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{forms.return}}</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 the original order</td>\n </tr>\n <tr>\n <td class=\"\">reasons</td>\n <td class=\"\">Reasons for return</td>\n </tr>\n <tr>\n <td class=\"\">actions</td>\n <td class=\"\">Return actions: an array of strings arbitrarily defined by the merchant: refund, exchange, credit, etc.</td>\n </tr>\n <tr>\n <td class=\"\">order_products</td>\n <td class=\"\">Array of products from the order that are available to return</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">id</span></td>\n <td class=\"\">ID for the product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">name</span></td>\n <td class=\"\">Name of this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">product_id</span></td>\n <td class=\"\">ID for this product</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">price</span></td>\n <td class=\"\">Price object that defines this product’s price</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">quantity</span></td>\n <td class=\"\">Quantity of the product returned</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">options</span></td>\n <td class=\"\">Array of additional product details (size, color, etc.), as name/value pairs</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\">name</span></td>\n <td class=\"\">Displayed name for this category of information</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent3\">value</span></td>\n <td class=\"\">Displayed value for this product’s entry</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"CreateAccount\"></a>Create Account</h2>\n\n<b>Description:</b> Object to enable the current customer to create a store account. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/pages/auth/create-account.html</span></nobr> template.) <br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{forms.create_account}}</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=\"\">recaptcha</td>\n <td class=\"\">Objects for integrating the Google reCAPTCHA service to distinguish human visitors from ’bots (automated agents)</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">enabled</span></td>\n <td class=\"\">Boolean indicating whether reCAPTCHA is enabled for this store</td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">public_key</span></td>\n <td class=\"\">Public key (site key) that reCAPTCHA returns upon merchant’s enabling CAPTCHA security in Store Settings > Display Settings</td>\n </tr>\n <tr>\n <td class=\"\">address_fields</td>\n <td class=\"\">Array of form fields that define each shipping address for this customer; for details, see this repo: <NOBR><a href=\"https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms\">https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms</a></nobr></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">class_name</span></td>\n <td class=\"\">Specifies a CSS class (defined in the theme's <span class=\"inline-code\">/assets/scss/</span> subdirectory) to apply to a field within the array; for corresponding control-panel steps, see this support article:\n <NOBR><a href=\"https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings\">https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings</a> </td>\n </tr>\n <tr>\n <td class=\"\">account_fields</td>\n <td class=\"\">Object of form fields; for details, see this repo:\n <NOBR><a href=\"https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms\">https://github.com/bigcommerce/cornerstone/tree/master/templates/components/common/forms</a></nobr></td>\n </tr>\n <tr>\n <td class=\"\"><span class=\"indent1\">class_name</span></td>\n <td class=\"\">Specifies a CSS class to apply to a field within the array; for corresponding control-panel steps, see:\n <NOBR><a href=\"https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings\">https://support.bigcommerce.com/articles/Public/Editing-Form-Fields#advanced-settings</a> </td>\n </tr>\n <tr>\n <td class=\"\">error</td>\n <td class=\"\">BCApp generated message to display when customer’s account creation fails</td>\n </tr>\n <tr>\n <td class=\"\">checking_out</td>\n <td class=\"\">Boolean indicating whether customer created the account during a purchase checkout</td>\n </tr>\n</table>\n\n\n<h2> <A NAME=\"ShipAddress\"></a>Shipping Addresses</h2>\n\n<b>Description:</b> Object to enable the customer to enter shipping and contact information. (Called on the default <NOBR><span class=\"inline-code\">&lt;theme-name&gt;/templates/components/account/address-list.html</span></nobr> partial.)<br>\n\n<b>Handlebars Expression:</b> <span class=\"inline-code\">{{customer.addresses}}</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 for this shipping address</td>\n </tr>\n <tr>\n <td class=\"\">customer_id</td>\n <td class=\"\">ID for this customer</td>\n </tr>\n <tr>\n <td class=\"\">first_name</td>\n <td class=\"\">First name to ship to</td>\n </tr>\n <tr>\n <td class=\"\">last_name</td>\n <td class=\"\">Last name to ship to</td>\n </tr>\n <tr>\n <td class=\"\">company</td>\n <td class=\"\">Company name to ship to</td>\n </tr>\n <tr>\n <td class=\"\">address1</td>\n <td class=\"\">Street (etc.) address, first line</td>\n </tr>\n <tr>\n <td class=\"\">address2</td>\n <td class=\"\">Street (etc.) address, second line</td>\n </tr>\n <tr>\n <td class=\"\">city</td>\n <td class=\"\">City to ship to</td>\n </tr>\n <tr>\n <td class=\"\">state</td>\n <td class=\"\">State/province/region to ship to</td>\n </tr>\n <tr>\n <td class=\"\">zip</td>\n <td class=\"\">Postal/ZIP code to ship to</td>\n </tr>\n <tr>\n <td class=\"\">country</td>\n <td class=\"\">Country to ship to</td>\n </tr>\n <tr>\n <td class=\"\">phone</td>\n <td class=\"\">Addressee’s phone number</td>\n </tr>\n <tr>\n <td class=\"\">state_id</td>\n <td class=\"\">ID for destination state/province/region</td>\n </tr>\n <tr>\n <td class=\"\">country_id</td>\n <td class=\"\">ID for destination country</td>\n </tr>\n <tr>\n <td class=\"\">destination</td>\n <td class=\"\">residential or commercial</td>\n </tr>\n <tr>\n <td class=\"\">last_used</td>\n <td class=\"\">Boolean, indicating whether this was the last-used shipping address for this customer</td>\n </tr>\n <tr>\n <td class=\"\">full_name</td>\n <td class=\"\">Full name of addressee</td>\n </tr>\n <tr>\n <td class=\"\">edit_url</td>\n <td class=\"\">URL for customer to edit this shipping address</td>\n </tr>\n <tr>\n <td class=\"\">delete_url</td>\n <td class=\"\">URL for customer to delete this shipping address </td>\n </tr>\n</table>" } [/block]