shopify-api-types

Version:

typings for Shopify Admin API

31 lines • 17.6 kB

HTML

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CustomerAddress | 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.CustomerAddress.html">CustomerAddress</a></li></ul><h1>Interface CustomerAddress</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-address#properties-2020-04">https://shopify.dev/docs/admin-api/rest/reference/customers/customer-address#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">CustomerAddress</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.CustomerAddress.html#address1" class="tsd-kind-icon">address1</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#address2" class="tsd-kind-icon">address2</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#city" class="tsd-kind-icon">city</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#company" class="tsd-kind-icon">company</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country" class="tsd-kind-icon">country</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country_code" class="tsd-kind-icon">country_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country_name" class="tsd-kind-icon">country_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.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.CustomerAddress.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.CustomerAddress.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#phone" class="tsd-kind-icon">phone</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#province" class="tsd-kind-icon">province</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#province_code" class="tsd-kind-icon">province_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#zip" class="tsd-kind-icon">zip</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="address1" class="tsd-anchor"></a><h3>address1</h3><div class="tsd-signature tsd-kind-icon">address1<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#L244">2021/01/payloads/customer.ts:244</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's mailing address</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="address2" class="tsd-anchor"></a><h3>address2</h3><div class="tsd-signature tsd-kind-icon">address2<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#L248">2021/01/payloads/customer.ts:248</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>An additional field for the customer's mailing address</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="city" class="tsd-anchor"></a><h3>city</h3><div class="tsd-signature tsd-kind-icon">city<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#L252">2021/01/payloads/customer.ts:252</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's city, town or village</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="company" class="tsd-anchor"></a><h3>company</h3><div class="tsd-signature tsd-kind-icon">company<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#L269">2021/01/payloads/customer.ts:269</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's company</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="country" class="tsd-anchor"></a><h3>country</h3><div class="tsd-signature tsd-kind-icon">country<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#L256">2021/01/payloads/customer.ts:256</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's country</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="country_code" class="tsd-anchor"></a><h3>country_<wbr/>code</h3><div class="tsd-signature tsd-kind-icon">country_<wbr/>code<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#L261">2021/01/payloads/customer.ts:261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The two-letter country code corresponding to the customer's country</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="country_name" class="tsd-anchor"></a><h3>country_<wbr/>name</h3><div class="tsd-signature tsd-kind-icon">country_<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#L265">2021/01/payloads/customer.ts:265</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's normalized country name</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#L273">2021/01/payloads/customer.ts:273</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="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#L277">2021/01/payloads/customer.ts:277</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="name" class="tsd-anchor"></a><h3>name</h3><div class="tsd-signature tsd-kind-icon">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#L281">2021/01/payloads/customer.ts:281</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's first and last name</p> </div></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#L285">2021/01/payloads/customer.ts:285</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's phone number at this address</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="province" class="tsd-anchor"></a><h3>province</h3><div class="tsd-signature tsd-kind-icon">province<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#L289">2021/01/payloads/customer.ts:289</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's region name. Typically a prvince, state or prefecture</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="province_code" class="tsd-anchor"></a><h3>province_<wbr/>code</h3><div class="tsd-signature tsd-kind-icon">province_<wbr/>code<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#L293">2021/01/payloads/customer.ts:293</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The two-letter code for the customer's region</p> </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="zip" class="tsd-anchor"></a><h3>zip</h3><div class="tsd-signature tsd-kind-icon">zip<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#L297">2021/01/payloads/customer.ts:297</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead"> <p>The customer's postal code, also known as zip, postcard, Eircode, etc.</p> </div></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.CustomerAddress.html" class="tsd-kind-icon">Customer<wbr/>Address</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#address1" class="tsd-kind-icon">address1</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#address2" class="tsd-kind-icon">address2</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#city" class="tsd-kind-icon">city</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#company" class="tsd-kind-icon">company</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country" class="tsd-kind-icon">country</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country_code" class="tsd-kind-icon">country_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#country_name" class="tsd-kind-icon">country_<wbr/>name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.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.CustomerAddress.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.CustomerAddress.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#phone" class="tsd-kind-icon">phone</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#province" class="tsd-kind-icon">province</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#province_code" class="tsd-kind-icon">province_<wbr/>code</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="2021_01.CustomerAddress.html#zip" class="tsd-kind-icon">zip</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>