@viyet/magento-client

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Cart | @viyet/magento-client</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">@viyet/magento-client</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="../modules/_modules_checkout_.html">"modules/Checkout"</a> </li> <li> <a href="../modules/_modules_checkout_.checkout.html">Checkout</a> </li> <li> <a href="_modules_checkout_.checkout.cart.html">Cart</a> </li> </ul> <h1>Interface Cart</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Cart Object</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Cart</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#billingaddressid" class="tsd-kind-icon">billing<wbr>Address<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#coupon" class="tsd-kind-icon">coupon</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#discountamount" class="tsd-kind-icon">discount<wbr>Amount</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#paymentmethod" class="tsd-kind-icon">payment<wbr>Method</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#products" class="tsd-kind-icon">products</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#shippingaddressid" class="tsd-kind-icon">shipping<wbr>Address<wbr>Id</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#shippingamount" class="tsd-kind-icon">shipping<wbr>Amount</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#shippingmethod" class="tsd-kind-icon">shipping<wbr>Method</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#subtotal" class="tsd-kind-icon">subtotal</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#tax" class="tsd-kind-icon">tax</a></li> <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_modules_checkout_.checkout.cart.html#totalprice" class="tsd-kind-icon">total<wbr>Price</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="billingaddressid" class="tsd-anchor"></a> <h3>billing<wbr>Address<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">billing<wbr>Address<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L15">modules/Checkout.ts:15</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="coupon" class="tsd-anchor"></a> <h3>coupon</h3> <div class="tsd-signature tsd-kind-icon">coupon<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L17">modules/Checkout.ts:17</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="discountamount" class="tsd-anchor"></a> <h3>discount<wbr>Amount</h3> <div class="tsd-signature tsd-kind-icon">discount<wbr>Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L18">modules/Checkout.ts:18</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="paymentmethod" class="tsd-anchor"></a> <h3>payment<wbr>Method</h3> <div class="tsd-signature tsd-kind-icon">payment<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L13">modules/Checkout.ts:13</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="products" class="tsd-anchor"></a> <h3>products</h3> <div class="tsd-signature tsd-kind-icon">products<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><a href="_modules_products_.product.fullproduct.html" class="tsd-signature-type">FullProduct</a><span class="tsd-signature-symbol">]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L12">modules/Checkout.ts:12</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="shippingaddressid" class="tsd-anchor"></a> <h3>shipping<wbr>Address<wbr>Id</h3> <div class="tsd-signature tsd-kind-icon">shipping<wbr>Address<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L14">modules/Checkout.ts:14</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="shippingamount" class="tsd-anchor"></a> <h3>shipping<wbr>Amount</h3> <div class="tsd-signature tsd-kind-icon">shipping<wbr>Amount<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L19">modules/Checkout.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="shippingmethod" class="tsd-anchor"></a> <h3>shipping<wbr>Method</h3> <div class="tsd-signature tsd-kind-icon">shipping<wbr>Method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L20">modules/Checkout.ts:20</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="subtotal" class="tsd-anchor"></a> <h3>subtotal</h3> <div class="tsd-signature tsd-kind-icon">subtotal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L16">modules/Checkout.ts:16</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="tax" class="tsd-anchor"></a> <h3>tax</h3> <div class="tsd-signature tsd-kind-icon">tax<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L21">modules/Checkout.ts:21</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <a name="totalprice" class="tsd-anchor"></a> <h3>total<wbr>Price</h3> <div class="tsd-signature tsd-kind-icon">total<wbr>Price<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">String</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L22">modules/Checkout.ts:22</a></li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/_modules_checkout_.checkout.api.html" class="tsd-kind-icon">API</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_modules_checkout_.checkout.addressform.html" class="tsd-kind-icon">Address<wbr>Form</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module"> <a href="_modules_checkout_.checkout.cart.html" class="tsd-kind-icon">Cart</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#billingaddressid" class="tsd-kind-icon">billing<wbr>Address<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#coupon" class="tsd-kind-icon">coupon</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#discountamount" class="tsd-kind-icon">discount<wbr>Amount</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#paymentmethod" class="tsd-kind-icon">payment<wbr>Method</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#products" class="tsd-kind-icon">products</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#shippingaddressid" class="tsd-kind-icon">shipping<wbr>Address<wbr>Id</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#shippingamount" class="tsd-kind-icon">shipping<wbr>Amount</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#shippingmethod" class="tsd-kind-icon">shipping<wbr>Method</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#subtotal" class="tsd-kind-icon">subtotal</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#tax" class="tsd-kind-icon">tax</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface"> <a href="_modules_checkout_.checkout.cart.html#totalprice" class="tsd-kind-icon">total<wbr>Price</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="_modules_checkout_.checkout.session.html" class="tsd-kind-icon">Session</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>