stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > MailingAddress

AdminTypes.MailingAddress interface

Represents a customer mailing address.

For example, a customer’s default address and an order’s billing address are both mailling addresses.

Signature:

export interface MailingAddress extends Node 

Extends: Node

Properties

Property Modifiers Type Description
address1?   Maybe<Scalars[‘String’][‘output’]> (Optional) The first line of the address. Typically the street address or PO Box number.
address2?   Maybe<Scalars[‘String’][‘output’]> (Optional) The second line of the address. Typically the number of the apartment, suite, or unit.
city?   Maybe<Scalars[‘String’][‘output’]> (Optional) The name of the city, district, village, or town.
company?   Maybe<Scalars[‘String’][‘output’]> (Optional) The name of the customer’s company or organization.
coordinatesValidated   Scalars[‘Boolean’][‘output’] Whether the address coordinates are valid.
country?   Maybe<Scalars[‘String’][‘output’]> (Optional) The name of the country.
countryCode?   Maybe<Scalars[‘String’][‘output’]> <p>(Optional) The two-letter code for the country of the address.</p><p>For example, US.</p>
countryCodeV2?   Maybe<CountryCode | `${CountryCode}`> <p>(Optional) The two-letter code for the country of the address.</p><p>For example, US.</p>
firstName?   Maybe<Scalars[‘String’][‘output’]> (Optional) The first name of the customer.
formatted   Array<Scalars[‘String’][‘output’]> A formatted version of the address, customized by the provided arguments.
formattedArea?   Maybe<Scalars[‘String’][‘output’]> (Optional) A comma-separated list of the values for city, province, and country.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
lastName?   Maybe<Scalars[‘String’][‘output’]> (Optional) The last name of the customer.
latitude?   Maybe<Scalars[‘Float’][‘output’]> (Optional) The latitude coordinate of the customer address.
longitude?   Maybe<Scalars[‘Float’][‘output’]> (Optional) The longitude coordinate of the customer address.
name?   Maybe<Scalars[‘String’][‘output’]> (Optional) The full name of the customer, based on firstName and lastName.
phone?   Maybe<Scalars[‘String’][‘output’]> <p>(Optional) A unique phone number for the customer.</p><p>Formatted using E.164 standard. For example, _+16135551111_.</p>
province?   Maybe<Scalars[‘String’][‘output’]> (Optional) The region of the address, such as the province, state, or district.
provinceCode?   Maybe<Scalars[‘String’][‘output’]> <p>(Optional) The two-letter code for the region.</p><p>For example, ON.</p>
timeZone?   Maybe<Scalars[‘String’][‘output’]> (Optional) The time zone of the address.
zip?   Maybe<Scalars[‘String’][‘output’]> (Optional) The zip or postal code of the address.