MailingAddress

Required access

unauthenticated_read_false access scope

Represents a mailing address for customers and shipping.

Show definition
# Represents a mailing address for customers and shipping.
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).

Required access

unauthenticated_read_ access scope

address2   (String)

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

Required access

unauthenticated_read_ access scope

city   (String)

City/District/Suburb/Town/Village.

Required access

unauthenticated_read_ access scope

company   (String)

Company/Organization/Government.

Required access

unauthenticated_read_ access scope

country   (String)

State/County/Province/Region.

Required access

unauthenticated_read_ access scope

countryCodeV2   (CountryCode)

Two-letter country code.

For example, US.

Required access

unauthenticated_read_ access scope

firstName   (String)

First name of the customer.

Required access

unauthenticated_read_ access scope

formatted   ([String!]!)

Required access

unauthenticated_read_ access scope

Argument Type Default Description
withCompany

Boolean

true

withName

Boolean

false

formattedArea   (String)

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

Required access

unauthenticated_read_ access scope

id   (ID!)

Globally unique identifier.

Required access

unauthenticated_read_ access scope

lastName   (String)

Last name of the customer.

Required access

unauthenticated_read_ access scope

latitude   (Float)

Latitude coordinate of the customer address.

Required access

unauthenticated_read_ access scope

longitude   (Float)

Longitude coordinate of the customer address.

Required access

unauthenticated_read_ access scope

name   (String)

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

Required access

unauthenticated_read_ access scope

phone   (String)

Unique phone number for the customer.

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

Required access

unauthenticated_read_ access scope

province   (String)

State/County/Province/Region.

Required access

unauthenticated_read_ access scope

provinceCode   (String)

Two-letter province or state code.

For example, ON.

Required access

unauthenticated_read_ access scope

zip   (String)

Zip/Postal Code.

Required access

unauthenticated_read_ access scope

Deprecated fields

Show/Hide

countryCode   (String)

deprecated

Two-letter country code.

For example, US.

Deprecation warning

Use countryCodeV2 instead

Required access

unauthenticated_read_ access scope

Sign up for a Partner account to get started.

Sign up