@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>API | @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.api.html">API</a> </li> </ul> <h1>Class API</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">API</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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_modules_checkout_.checkout.api.html#transport" class="tsd-kind-icon">transport</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#applycouponcode" class="tsd-kind-icon">apply<wbr>Coupon<wbr>Code</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#createaddress" class="tsd-kind-icon">create<wbr>Address</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#editaddress" class="tsd-kind-icon">edit<wbr>Address</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#getaddresses" class="tsd-kind-icon">get<wbr>Addresses</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#getcurrentorder" class="tsd-kind-icon">get<wbr>Current<wbr>Order</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#getformkey" class="tsd-kind-icon">get<wbr>Form<wbr>Key</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#getpayments" class="tsd-kind-icon">get<wbr>Payments</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_modules_checkout_.checkout.api.html#removecoupon" class="tsd-kind-icon">remove<wbr>Coupon</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new API<span class="tsd-signature-symbol">(</span>transport<span class="tsd-signature-symbol">: </span><a href="_modules_transport_.transport.api.html" class="tsd-signature-type">API</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_modules_checkout_.checkout.api.html" class="tsd-signature-type">API</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L54">modules/Checkout.ts:54</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Products handler class</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>transport: <a href="_modules_transport_.transport.api.html" class="tsd-signature-type">API</a></h5> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>API transport handler</p> </div> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_modules_checkout_.checkout.api.html" class="tsd-signature-type">API</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="transport" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> transport</h3> <div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <a href="_modules_transport_.transport.api.html" class="tsd-signature-type">API</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L54">modules/Checkout.ts:54</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Handles communication with API</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="applycouponcode" class="tsd-anchor"></a> <h3>apply<wbr>Coupon<wbr>Code</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">apply<wbr>Coupon<wbr>Code<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a>, couponCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L92">modules/Checkout.ts:92</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Applies coupon code to current order</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> <li> <h5>couponCode: <span class="tsd-signature-type">String</span></h5> <div class="tsd-comment tsd-typography"> <p>Coupon Code to apply</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to an apply coupon result</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="createaddress" class="tsd-anchor"></a> <h3>create<wbr>Address</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<wbr>Address<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a>, addressFormInput<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.addressform.html" class="tsd-signature-type">AddressForm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L171">modules/Checkout.ts:171</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Create new shipping address</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> <li> <h5>addressFormInput: <a href="../interfaces/_modules_checkout_.checkout.addressform.html" class="tsd-signature-type">AddressForm</a></h5> <div class="tsd-comment tsd-typography"> <p>Address Form Input</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to the newly created shipping address</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="editaddress" class="tsd-anchor"></a> <h3>edit<wbr>Address</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">edit<wbr>Address<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a>, shippingAddressId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">String</span>, addressFormInput<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.addressform.html" class="tsd-signature-type">AddressForm</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L192">modules/Checkout.ts:192</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Edit shipping address</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> <li> <h5>shippingAddressId: <span class="tsd-signature-type">String</span></h5> <div class="tsd-comment tsd-typography"> <p>Shipping Address Id</p> </div> </li> <li> <h5>addressFormInput: <a href="../interfaces/_modules_checkout_.checkout.addressform.html" class="tsd-signature-type">AddressForm</a></h5> <div class="tsd-comment tsd-typography"> <p>Address Form Input</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to the edited shipping address</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getaddresses" class="tsd-anchor"></a> <h3>get<wbr>Addresses</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Addresses<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L215">modules/Checkout.ts:215</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get all shipping address</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to all of a logged in customer's shipping addresses</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getcurrentorder" class="tsd-anchor"></a> <h3>get<wbr>Current<wbr>Order</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Current<wbr>Order<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L73">modules/Checkout.ts:73</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets current order</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to an object with product create result</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getformkey" class="tsd-anchor"></a> <h3>get<wbr>Form<wbr>Key</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Form<wbr>Key<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L154">modules/Checkout.ts:154</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets form_key</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>form_key value as a string</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="getpayments" class="tsd-anchor"></a> <h3>get<wbr>Payments</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Payments<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L137">modules/Checkout.ts:137</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets saved payments</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to an object with product create result</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="removecoupon" class="tsd-anchor"></a> <h3>remove<wbr>Coupon</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">remove<wbr>Coupon<span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a>, session<span class="tsd-signature-symbol">: </span><a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/viyet/magento-client/blob/3d091c4/src/modules/Checkout.ts#L115">modules/Checkout.ts:115</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Removes coupon from current order</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>headers: <a href="../interfaces/_modules_transport_.transport.headers.html" class="tsd-signature-type">Headers</a></h5> <div class="tsd-comment tsd-typography"> <p>Request headers</p> </div> </li> <li> <h5>session: <a href="../interfaces/_modules_checkout_.checkout.session.html" class="tsd-signature-type">Session</a></h5> <div class="tsd-comment tsd-typography"> <p>Checkout Session</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">></span></h4> <p>A Promise that resolves to an apply coupon result</p> </li> </ul> </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"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="_modules_checkout_.checkout.api.html" class="tsd-kind-icon">API</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_modules_checkout_.checkout.api.html#transport" class="tsd-kind-icon">transport</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#applycouponcode" class="tsd-kind-icon">apply<wbr>Coupon<wbr>Code</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#createaddress" class="tsd-kind-icon">create<wbr>Address</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#editaddress" class="tsd-kind-icon">edit<wbr>Address</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#getaddresses" class="tsd-kind-icon">get<wbr>Addresses</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#getcurrentorder" class="tsd-kind-icon">get<wbr>Current<wbr>Order</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#getformkey" class="tsd-kind-icon">get<wbr>Form<wbr>Key</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#getpayments" class="tsd-kind-icon">get<wbr>Payments</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_modules_checkout_.checkout.api.html#removecoupon" class="tsd-kind-icon">remove<wbr>Coupon</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_modules_checkout_.checkout.addressform.html" class="tsd-kind-icon">Address<wbr>Form</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_modules_checkout_.checkout.cart.html" class="tsd-kind-icon">Cart</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_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>