MailingAddressInput

The fields used to create or update a mailing address.

Show definition

# The fields used to create or update a mailing address.
input MailingAddressInput {
  # 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. This argument is deprecated: Use countryCode instead. country: String

# The two-letter code for the country of the address. countryCode: CountryCode

# The first name of the customer. firstName: String

# This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed. id: ID

# The last name of the customer. lastName: 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. This # argument is deprecated: Use provinceCode instead. province: String

# The code for the region of the address, such as the province, state, or district. # For example QC for Quebec, Canada. provinceCode: String

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

Input 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. This argument is deprecated: Use countryCode instead.

countryCode   (CountryCode)

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

firstName   (String)

The first name of the customer.

id   (ID)

This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

lastName   (String)

The last name of the customer.

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. This argument is deprecated: Use provinceCode instead.

provinceCode   (String)

The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.

zip   (String)

The zip or postal code of the address.

Sign up for a Partner account to get started.

Sign up