Skip to main content
Anchor to MailingAddress

MailingAddress

object

Represents a mailing address for customers and shipping.

Anchor to FieldsFields

Anchor to address1address1
•String

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

Anchor to address2address2
•String

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

Anchor to citycity
•String

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

Anchor to companycompany
•String

The name of the customer's company or organization.

Anchor to countrycountry
•String

The name of the country.

Anchor to countryCodeV2countryCodeV2
•CountryCode

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

For example, US.

Anchor to firstNamefirstName
•String

The first name of the customer.

Anchor to formattedformatted
•[String!]!
non-null

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

Arguments

Anchor to withNamewithName
•Boolean
Default:false

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

Anchor to withCompanywithCompany
•Boolean
Default:true

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

Anchor to formattedAreaformattedArea
•String

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

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to lastNamelastName
•String

The last name of the customer.

Anchor to latitudelatitude
•Float

The latitude coordinate of the customer address.

Anchor to longitudelongitude
•Float

The longitude coordinate of the customer address.

Anchor to namename
•String

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

Anchor to phonephone
•String

A unique phone number for the customer.

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

Anchor to provinceprovince
•String

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

Anchor to provinceCodeprovinceCode
•String

The alphanumeric code for the region.

For example, ON.

Anchor to zipzip
•String

The zip or postal code of the address.

Anchor to countryCodecountryCode
•String
Deprecated
Was this section helpful?

Anchor to MutationsMutations

Anchor to customerAddressCreatecustomerAddressCreate
•mutation

Creates a new address for a customer.

Anchor to customerAddressUpdatecustomerAddressUpdate
•mutation

Updates the address of an existing customer.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?