Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 3.09 KB

address.md

File metadata and controls

50 lines (41 loc) · 3.09 KB
Raw

Address

Represents a postal address in a country. For more information, see Working with Addresses.

Structure

Address

Fields

Name Type Tags Description
addressLine1 string | undefined Optional The first line of the address.

Fields that start with address_line provide the address's most specific
details, like street number, street name, and building name. They do not
provide less specific details like city, state/province, or country (these
details are provided in other fields).
addressLine2 string | undefined Optional The second line of the address, if any.
addressLine3 string | undefined Optional The third line of the address, if any.
locality string | undefined Optional The city or town of the address. For a full list of field meanings by country, see Working with Addresses.
sublocality string | undefined Optional A civil region within the address's locality, if any.
sublocality2 string | undefined Optional A civil region within the address's sublocality, if any.
sublocality3 string | undefined Optional A civil region within the address's sublocality_2, if any.
administrativeDistrictLevel1 string | undefined Optional A civil entity within the address's country. In the US, this
is the state. For a full list of field meanings by country, see Working with Addresses.
administrativeDistrictLevel2 string | undefined Optional A civil entity within the address's administrative_district_level_1.
In the US, this is the county.
administrativeDistrictLevel3 string | undefined Optional A civil entity within the address's administrative_district_level_2,
if any.
postalCode string | undefined Optional The address's postal code. For a full list of field meanings by country, see Working with Addresses.
country string | undefined Optional Indicates the country associated with another entity, such as a business.
Values are in ISO 3166-1-alpha-2 format.
firstName string | undefined Optional Optional first name when it's representing recipient.
lastName string | undefined Optional Optional last name when it's representing recipient.

Example (as JSON)

{
  "address_line_1": null,
  "address_line_2": null,
  "address_line_3": null,
  "locality": null,
  "sublocality": null,
  "sublocality_2": null,
  "sublocality_3": null,
  "administrative_district_level_1": null,
  "administrative_district_level_2": null,
  "administrative_district_level_3": null,
  "postal_code": null,
  "country": null,
  "first_name": null,
  "last_name": null
}