Skip to main content

MyAddress

A buyer-owned ordering location, backed by an Address row (type SHIPPING/DELIVERY). isActive: false means the address is pending a seller's approval and cannot be ordered against.

type MyAddress {
  addressLine1: 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
  zone: String
}

Fields​

MyAddress.addressLine1 ● String scalar​

The first line of the address.

MyAddress.addressType ● AddressType! non-null enum​

Address classification (AddressType enum).

MyAddress.city ● String scalar​

The city.

MyAddress.country ● String scalar​

The country.

MyAddress.createdAt ● DateTime! non-null scalar​

When the record was created.

MyAddress.id ● ID! non-null scalar​

The unique ID of this record.

MyAddress.isActive ● Boolean! non-null scalar​

Whether the record is active.

MyAddress.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), so this is the flag that distinguishes a shipping-only address from a shipping+billing one. Drives the cart/checkout heading: 'Shipping To' / 'Billing To' / 'Billing & Shipping'. Nullable for app builds that predate it.

MyAddress.lat ● Float scalar​

The latitude of the address on the map.

MyAddress.lng ● Float scalar​

The longitude of the address on the map.

MyAddress.name ● String! non-null scalar​

The name of the address.

MyAddress.phone ● String! non-null scalar​

Phone number.

MyAddress.postalCode ● String scalar​

The postal code. Empty when the buyer has none.

MyAddress.state ● String scalar​

The state or region.

MyAddress.zone ● String scalar​

The delivery zone of the address.

Returned By​

myAddresses query