CustomerAddress

An address of the customer.

type CustomerAddress {
  city: String!
  contactPhone: String
  country: String
  id: ID!
  isDefault: Boolean!
  isDualPurpose: Boolean!
  label: String
  latitude: Float
  longitude: Float
  postalCode: String!
  state: String!
  street1: String!
  street2: String
  type: AddressType!
}

Fields

CustomerAddress.city ● String! non-null scalar

The city.

CustomerAddress.contactPhone ● String scalar

The phone number for this location, not the account's.

CustomerAddress.country ● String scalar

The country.

CustomerAddress.id ● ID! non-null scalar

The unique ID of this record.

CustomerAddress.isDefault ● Boolean! non-null scalar

Whether this is the default.

CustomerAddress.isDualPurpose ● Boolean! non-null scalar

True when the address also serves the other role: a shipping address that can be billed to, or a billing address that can be delivered to.

CustomerAddress.label ● String scalar

A label for the address.

CustomerAddress.latitude ● Float scalar

The latitude of the address on the map.

CustomerAddress.longitude ● Float scalar

The longitude of the address on the map.

CustomerAddress.postalCode ● String! non-null scalar

The postal code.

CustomerAddress.state ● String! non-null scalar

The state or region.

CustomerAddress.street1 ● String! non-null scalar

The first line of the street address.

CustomerAddress.street2 ● String scalar

The second line of the street address.

CustomerAddress.type ● AddressType! non-null enum

The kind of address, for example shipping or billing.

Returned By

customerAddresses query ● customerCreateAddress mutation ● customerSetDefaultAddress mutation ● customerUpdateAddress mutation