Skip to main content

AddressInput Input

Description​

Input fields for specifying a physical address.

Declaration​

input AddressInput {
description: String
addressLine1: String
addressLine2: String
streetNumber: Int
city: String
state: String
postCode: String
alpha2: String
country: String
stateCode: String
type: String
geoLoc: GeoLocInput
}

Fields​

NameTypeDescription
descriptionStringOptional description or label for the address.
addressLine1StringPrimary street address line.
addressLine2StringSecondary street address line, such as apartment or suite number.
streetNumberIntStreet number component of the address.
cityStringCity or locality name.
stateStringState or province name.
postCodeStringPostal or ZIP code.
alpha2StringTwo-letter ISO 3166-1 alpha-2 country code.
countryStringFull country name.
stateCodeStringState or province code abbreviation.
typeStringType of address, such as billing or shipping.
geoLocGeoLocInputGeographic location coordinates for the address.