Skip to main content

MobileAddress

An ordering address of the buyer.

type MobileAddress {
  addressLine1: String!
  addressLine2: String
  addressType: AddressType!
  city: String!
  country: String!
  createdAt: DateTime!
  id: ID!
  isActive: Boolean!
  isDualPurpose: Boolean
  lat: Float
  lng: Float
  name: String!
  phone: String!
  postalCode: String
  state: String
}

Fields​

MobileAddress.addressLine1 ● String! non-null scalar​

The first line of the address.

MobileAddress.addressLine2 ● String scalar​

The second line of the address.

MobileAddress.addressType ● AddressType! non-null enum​

Address classification (AddressType enum).

MobileAddress.city ● String! non-null scalar​

The city.

MobileAddress.country ● String! non-null scalar​

The country.

MobileAddress.createdAt ● DateTime! non-null scalar​

When the record was created.

MobileAddress.id ● ID! non-null scalar​

The unique ID of this record.

MobileAddress.isActive ● Boolean! non-null scalar​

Whether the record is active.

MobileAddress.isDualPurpose ● Boolean scalar​

TRUE when this address also serves the OTHER role — a SHIPPING address that is billed to as well, or vice versa. addressType stays the primary classification (one enum column cannot hold two roles). Drives the cart/checkout heading: 'Shipping To' / 'Billing To' / 'Billing & Shipping'. Nullable for app builds that predate it.

MobileAddress.lat ● Float scalar​

The latitude of the address on the map.

MobileAddress.lng ● Float scalar​

The longitude of the address on the map.

MobileAddress.name ● String! non-null scalar​

The name of the address.

MobileAddress.phone ● String! non-null scalar​

Phone number.

MobileAddress.postalCode ● String scalar​

The postal code.

MobileAddress.state ● String scalar​

The state or region.

Returned By​

createAddress mutation