MailingAddress

Specifies the input fields for a mailing address.

Show definition
# Specifies the input fields for a mailing address.
type MailingAddress implements Node {
  # Globally unique identifier.
  id: ID!

  # Address line 1 (Street address/PO Box/Company name).
  address1: String

  # Address line 2 (Apartment/Suite/Unit/Building).
  address2: String

  # City/District/Suburb/Town/Village.
  city: String

  # Company/Organization/Government.
  company: String

  # State/County/Province/Region.
  country: String

  # Two-letter country code.
  #
  # For example, US.
  countryCode: String

  # Two-letter country code.
  #
  # For example, US.
  countryCodeV2: CountryCode

  # First name of the customer.
  firstName: String
  formatted(withName: Boolean = false, withCompany: Boolean = true): [String!]!

  # Comma-separated list of city, province, and country.
  formattedArea: String

  # Last name of the customer.
  lastName: String

  # Latitude coordinate of the customer address.
  latitude: Float

  # Longitude coordinate of the customer address.
  longitude: Float

  # Name of the customer, based on first name + last name.
  name: String

  # Unique phone number for the customer.
  #
  # Formatted using E.164 standard. For example, _+16135551111_.
  phone: String

  # State/County/Province/Region.
  province: String

  # Two-letter province or state code.
  #
  # For example, ON.
  provinceCode: String

  # Zip/Postal Code.
  zip: String
}

Implements

Fields

address1   (String)

Address line 1 (Street address/PO Box/Company name).

address2   (String)

Address line 2 (Apartment/Suite/Unit/Building).

city   (String)

City/District/Suburb/Town/Village.

company   (String)

Company/Organization/Government.

country   (String)

State/County/Province/Region.

countryCodeV2   (CountryCode)

Two-letter country code.

For example, US.

firstName   (String)

First name of the customer.

formatted   ([String!]!)

Argument Type Default Description
withCompany Boolean true
withName Boolean false

formattedArea   (String)

Comma-separated list of city, province, and country.

id   (ID!)

Globally unique identifier.

lastName   (String)

Last name of the customer.

latitude   (Float)

Latitude coordinate of the customer address.

longitude   (Float)

Longitude coordinate of the customer address.

name   (String)

Name of the customer, based on first name + last name.

phone   (String)

Unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.

province   (String)

State/County/Province/Region.

provinceCode   (String)

Two-letter province or state code.

For example, ON.

zip   (String)

Zip/Postal Code.

Deprecated fields

Show/Hide

countryCode   (String) deprecated

Two-letter country code.

For example, US.

Deprecation warning

Use countryCodeV2 instead