MailingAddress

Represents a customer mailing address.

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

Show definition

# Represents a customer mailing address.

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

type MailingAddress implements Node { # Globally unique identifier. id: ID!

# The first line of the address. Typically the street address or PO Box number. address1: String

# The second line of the address. Typically the number of the apartment, suite, or unit. address2: String

# The name of the city, district, village, or town. city: String

# The name of the customer's company or organization. company: String

# The name of the country. country: String

# The two-letter code for the country of the address. # # For example, US. countryCode: String

# The two-letter code for the country of the address. # # For example, US. countryCodeV2: CountryCode

# The first name of the customer. firstName: String

# A formatted version of the address, customized by the provided arguments. formatted( # Whether to include the customer's name in the formatted address. withName: Boolean = false

# Whether to include the customer's company in the formatted address. withCompany: Boolean = true ): [String!]!

# A comma-separated list of the values for city, province, and country. formattedArea: String

# The last name of the customer. lastName: String

# The latitude coordinate of the customer address. latitude: Float

# The longitude coordinate of the customer address. longitude: Float

# The full name of the customer, based on firstName and lastName. name: String

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

# The region of the address, such as the province, state, or district. province: String

# The two-letter code for the region. # # For example, ON. provinceCode: String

# The zip or postal code of the address. zip: String }

Implements

Fields

address1   (String)

The first line of the address. Typically the street address or PO Box number.

address2   (String)

The second line of the address. Typically the number of the apartment, suite, or unit.

city   (String)

The name of the city, district, village, or town.

company   (String)

The name of the customer's company or organization.

country   (String)

The name of the country.

countryCodeV2   (CountryCode)

The two-letter code for the country of the address.

For example, US.

firstName   (String)

The first name of the customer.

formatted   ([String!]!)

A formatted version of the address, customized by the provided arguments.

Argument Type Default Description
withCompany

Boolean

true

Whether to include the customer's company in the formatted address.

withName

Boolean

false

Whether to include the customer's name in the formatted address.

formattedArea   (String)

A comma-separated list of the values for city, province, and country.

id   (ID!)

Globally unique identifier.

lastName   (String)

The last name of the customer.

latitude   (Float)

The latitude coordinate of the customer address.

longitude   (Float)

The longitude coordinate of the customer address.

name   (String)

The full name of the customer, based on firstName and lastName.

phone   (String)

A unique phone number for the customer.

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

province   (String)

The region of the address, such as the province, state, or district.

provinceCode   (String)

The two-letter code for the region.

For example, ON.

zip   (String)

The zip or postal code of the address.

Deprecated fields

Show/Hide

countryCode   (String)

deprecated

The two-letter code for the country of the address.

For example, US.

Deprecation warning

Use countryCodeV2 instead

Sign up for a Partner account to get started.

Sign up