Skip to main content

Address Object

Description

Physical address information for shipping or billing.

Declaration

type Address {
_id: ID
description: String
firstName: String
lastName: String
addressLine1: String
addressLine2: String
streetNumber: Int
city: String
state: String
stateCode: String
postCode: String
alpha2: String
country: String
type: String
geoLoc: AddressGeoLoc
}

Fields

NameTypeDescription
_idIDInternal database identifier.
descriptionStringOptional description or label for the address.
firstNameStringFirst name of the address recipient.
lastNameStringLast name of the address recipient.
addressLine1StringPrimary street address line.
addressLine2StringSecondary street address line (e.g., apartment, suite number).
streetNumberIntStreet number component of the address.
cityStringCity or locality name.
stateStringState or province name.
stateCodeStringState or province code abbreviation.
postCodeStringPostal or ZIP code.
alpha2StringTwo-letter ISO 3166-1 alpha-2 country code.
countryStringFull country name.
typeStringType of address (e.g., "billing", "shipping").
geoLocAddressGeoLocGeographic location coordinates for the address.