Docs
Dashboard

CustomerAddressInput

Input

Specifies the fields to use when creating/updating an address.

#

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 apartment, suite, or unit number.

city
String

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

company
String

The name of the customer’s company or organization.

countryCode
String

The two-letter ISO 3166-1 alpha-2 country code of the address.

email
String

The email address associated with the address.

firstName
String

The first name of the address.

isDefaultBilling
Boolean

Indicates whether the address should be set as the customer’s default billing address.

isDefaultShipping
Boolean

Indicates whether the address should be set as the customer’s default shipping address.

lastName
String

The last name of the address.

metadata
[KeyValuePairOfStringAndStringInput!]

The metadata of the address, which can be used to store additional information about the address.

name
String

The name of the address.

phone
String

The address’s unique phone number, formatted using E.164 standard. For example, +16135551111.

postalCode
String

The zip or postal code of the address.

state
String

The name of the state, province, or region. For example, Colorado.