shopify-api-types

Version:

typings for Shopify Admin API

51 lines • 29.8 kB

HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Customer | Shopify API Types</title><meta name="description" content="Documentation for Shopify API Types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">Shopify API Types</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-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</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="../modules.html">Shopify API Types</a></li><li><a href="../modules/2021_01.html">2021/01</a></li><li><a href="2021_01.Customer.html">Customer</a></li></ul><h1>Interface Customer</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><a href="https://shopify.dev/docs/admin-api/rest/reference/customers/customer#properties-2020-04">https://shopify.dev/docs/admin-api/rest/reference/customers/customer#properties-2020-04</a></p> </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Customer</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="2021_01.Customer.html#accepts_marketing" class="tsd-kind-icon">accepts_<wbr/>marketing</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#accepts_marketing_updated_at" class="tsd-kind-icon">accepts_<wbr/>marketing_<wbr/>updated_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#addresses" class="tsd-kind-icon">addresses</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#created_at" class="tsd-kind-icon">created_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#currency" class="tsd-kind-icon">currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#default_address" class="tsd-kind-icon">default_<wbr/>address</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#first_name" class="tsd-kind-icon">first_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_name" class="tsd-kind-icon">last_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_order_id" class="tsd-kind-icon">last_<wbr/>order_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_order_name" class="tsd-kind-icon">last_<wbr/>order_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#marketing_opt_in_level" class="tsd-kind-icon">marketing_<wbr/>opt_<wbr/>in_<wbr/>level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#metafield" class="tsd-kind-icon">metafield</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#multipass_identifier" class="tsd-kind-icon">multipass_<wbr/>identifier</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#orders_count" class="tsd-kind-icon">orders_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#phone" class="tsd-kind-icon">phone</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#state" class="tsd-kind-icon">state</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tags" class="tsd-kind-icon">tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tax_exempt" class="tsd-kind-icon">tax_<wbr/>exempt</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tax_exemptions" class="tsd-kind-icon">tax_<wbr/>exemptions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#total_spent" class="tsd-kind-icon">total_<wbr/>spent</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#updated_at" class="tsd-kind-icon">updated_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#verified_email" class="tsd-kind-icon">verified_<wbr/>email</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="accepts_marketing" class="tsd-anchor"></a><h3>accepts_<wbr/>marketing</h3><div class="tsd-signature tsd-kind-icon">accepts_<wbr/>marketing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L137">2021/01/payloads/customer.ts:137</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Whether the customer has consented to receive marketing material via email</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="accepts_marketing_updated_at" class="tsd-anchor"></a><h3>accepts_<wbr/>marketing_<wbr/>updated_<wbr/>at</h3><div class="tsd-signature tsd-kind-icon">accepts_<wbr/>marketing_<wbr/>updated_<wbr/>at<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L141">2021/01/payloads/customer.ts:141</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The date when the customer consented to recieving marketing material by email</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="addresses" class="tsd-anchor"></a><h3>addresses</h3><div class="tsd-signature tsd-kind-icon">addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="2021_01.Customer.html" class="tsd-signature-type" data-tsd-kind="Interface">Customer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>customer_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L145">2021/01/payloads/customer.ts:145</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>A list of the ten most recently updated addresses for the customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="created_at" class="tsd-anchor"></a><h3>created_<wbr/>at</h3><div class="tsd-signature tsd-kind-icon">created_<wbr/>at<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L154">2021/01/payloads/customer.ts:154</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The date the customer was created</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="currency" class="tsd-anchor"></a><h3>currency</h3><div class="tsd-signature tsd-kind-icon">currency<span class="tsd-signature-symbol">:</span> <a href="../enums/common.CurrencyCode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CurrencyCode</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L150">2021/01/payloads/customer.ts:150</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The three-letter code for the currency that the customer used when they paid for their last order.</p> </div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="default_address" class="tsd-anchor"></a><h3>default_<wbr/>address</h3><div class="tsd-signature tsd-kind-icon">default_<wbr/>address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="2021_01.Customer.html" class="tsd-signature-type" data-tsd-kind="Interface">Customer</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"name"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>customer_id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L158">2021/01/payloads/customer.ts:158</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The default address for the customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="email" class="tsd-anchor"></a><h3>email</h3><div class="tsd-signature tsd-kind-icon">email<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L162">2021/01/payloads/customer.ts:162</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The unique email for the customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="first_name" class="tsd-anchor"></a><h3>first_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">first_<wbr/>name<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L166">2021/01/payloads/customer.ts:166</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's first name</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="id" class="tsd-anchor"></a><h3>id</h3><div class="tsd-signature tsd-kind-icon">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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L170">2021/01/payloads/customer.ts:170</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The unique id for the customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="last_name" class="tsd-anchor"></a><h3>last_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">last_<wbr/>name<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L174">2021/01/payloads/customer.ts:174</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's last name</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="last_order_id" class="tsd-anchor"></a><h3>last_<wbr/>order_<wbr/>id</h3><div class="tsd-signature tsd-kind-icon">last_<wbr/>order_<wbr/>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L179">2021/01/payloads/customer.ts:179</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The id of the customer's last order</p> </div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="last_order_name" class="tsd-anchor"></a><h3>last_<wbr/>order_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">last_<wbr/>order_<wbr/>name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L183">2021/01/payloads/customer.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The name of the customer's last order</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="marketing_opt_in_level" class="tsd-anchor"></a><h3>marketing_<wbr/>opt_<wbr/>in_<wbr/>level</h3><div class="tsd-signature tsd-kind-icon">marketing_<wbr/>opt_<wbr/>in_<wbr/>level<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"single_opt_in"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"confirmed_opt_in"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"unknown"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L191">2021/01/payloads/customer.ts:191</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The marketing level subscription opt-in level</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="metafield" class="tsd-anchor"></a><h3>metafield</h3><div class="tsd-signature tsd-kind-icon">metafield<span class="tsd-signature-symbol">:</span> <a href="2021_01.Metafield.html" class="tsd-signature-type" data-tsd-kind="Interface">Metafield</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L187">2021/01/payloads/customer.ts:187</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Attached additional metadata</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="multipass_identifier" class="tsd-anchor"></a><h3>multipass_<wbr/>identifier</h3><div class="tsd-signature tsd-kind-icon">multipass_<wbr/>identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L195">2021/01/payloads/customer.ts:195</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The unique identifier for the customer that's used with Multipass login</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="orders_count" class="tsd-anchor"></a><h3>orders_<wbr/>count</h3><div class="tsd-signature tsd-kind-icon">orders_<wbr/>count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L200">2021/01/payloads/customer.ts:200</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The number of orders associated with this customer</p> </div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="phone" class="tsd-anchor"></a><h3>phone</h3><div class="tsd-signature tsd-kind-icon">phone<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L204">2021/01/payloads/customer.ts:204</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The unique phone number for this customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="state" class="tsd-anchor"></a><h3>state</h3><div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../enums/2021_01.CustomerAccountState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CustomerAccountState</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L208">2021/01/payloads/customer.ts:208</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The state of the customer's account with the shop</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tags" class="tsd-anchor"></a><h3>tags</h3><div class="tsd-signature tsd-kind-icon">tags<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L212">2021/01/payloads/customer.ts:212</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>A list of comma-separated values of tags the shop owner has attached to a customer</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tax_exempt" class="tsd-anchor"></a><h3>tax_<wbr/>exempt</h3><div class="tsd-signature tsd-kind-icon">tax_<wbr/>exempt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L216">2021/01/payloads/customer.ts:216</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Whether the customer is except from paying taxes on their order</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="tax_exemptions" class="tsd-anchor"></a><h3>tax_<wbr/>exemptions</h3><div class="tsd-signature tsd-kind-icon">tax_<wbr/>exemptions<span class="tsd-signature-symbol">:</span> <a href="../enums/2021_01.CustomerTaxExceptions.html" class="tsd-signature-type" data-tsd-kind="Enumeration">CustomerTaxExceptions</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L220">2021/01/payloads/customer.ts:220</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Whether the customer is excempt from paying specific taxes on their order. Canadian taxes only.</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="total_spent" class="tsd-anchor"></a><h3>total_<wbr/>spent</h3><div class="tsd-signature tsd-kind-icon">total_<wbr/>spent<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L225">2021/01/payloads/customer.ts:225</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The total amount of money the customer has spent across their order</p> </div><dl class="tsd-comment-tags"><dt>readonly</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="updated_at" class="tsd-anchor"></a><h3>updated_<wbr/>at</h3><div class="tsd-signature tsd-kind-icon">updated_<wbr/>at<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/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L229">2021/01/payloads/customer.ts:229</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The date when the customer information was last updated</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="verified_email" class="tsd-anchor"></a><h3>verified_<wbr/>email</h3><div class="tsd-signature tsd-kind-icon">verified_<wbr/>email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Fyko/shopify-api-types/blob/7a2c506/2021/01/payloads/customer.ts#L234">2021/01/payloads/customer.ts:234</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>Whether the customer has verified their email</p> </div><dl class="tsd-comment-tags"><dt>reaodnly</dt><dd></dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/2021_01.html">2021/01</a></li><li class=" tsd-kind-module"><a href="../modules/common.html">common</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="2021_01.Customer.html" class="tsd-kind-icon">Customer</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#accepts_marketing" class="tsd-kind-icon">accepts_<wbr/>marketing</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#accepts_marketing_updated_at" class="tsd-kind-icon">accepts_<wbr/>marketing_<wbr/>updated_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#addresses" class="tsd-kind-icon">addresses</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#created_at" class="tsd-kind-icon">created_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#currency" class="tsd-kind-icon">currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#default_address" class="tsd-kind-icon">default_<wbr/>address</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#email" class="tsd-kind-icon">email</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#first_name" class="tsd-kind-icon">first_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_name" class="tsd-kind-icon">last_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_order_id" class="tsd-kind-icon">last_<wbr/>order_<wbr/>id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#last_order_name" class="tsd-kind-icon">last_<wbr/>order_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#marketing_opt_in_level" class="tsd-kind-icon">marketing_<wbr/>opt_<wbr/>in_<wbr/>level</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#metafield" class="tsd-kind-icon">metafield</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#multipass_identifier" class="tsd-kind-icon">multipass_<wbr/>identifier</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#orders_count" class="tsd-kind-icon">orders_<wbr/>count</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#phone" class="tsd-kind-icon">phone</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#state" class="tsd-kind-icon">state</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tags" class="tsd-kind-icon">tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tax_exempt" class="tsd-kind-icon">tax_<wbr/>exempt</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#tax_exemptions" class="tsd-kind-icon">tax_<wbr/>exemptions</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#total_spent" class="tsd-kind-icon">total_<wbr/>spent</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#updated_at" class="tsd-kind-icon">updated_<wbr/>at</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.Customer.html#verified_email" class="tsd-kind-icon">verified_<wbr/>email</a></li></ul></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-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-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>