Skip to main content

Address Object

Description

Represents a physical address.

Declaration

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

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.
streetNumberStringStreet number component.
cityStringCity or locality name.
stateStringState or province name.
stateCodeStringState or province code abbreviation.
postCodeStringPostal or ZIP code.
countryStringFull country name.
alpha2StringTwo-letter ISO 3166-1 alpha-2 country code.
typeStringType of address (e.g., "billing", "shipping").