PostalAddress

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

integer

La revisión del esquema de PostalAddress. Se debe configurar como 0, que es la última versión.

Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores.

string

Obligatorio Código de región de CLDR para el país o la región de la dirección. Nunca se infiere y depende del usuario garantizar que el valor sea correcto. Consulta http://cldr.unicode.org/ y http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para obtener más información. Ejemplo: "CH" para Suiza.

string

Opcional: Código de idioma BCP-47 de los contenidos de esta dirección (si se conoce). Suele ser el idioma de la IU del formulario de entrada o se espera que coincida con uno de los idiomas usados en la región o el país de la dirección, o sus transliteraciones equivalentes. Esto puede afectar el formato en ciertos países, pero no es fundamental para la precisión de los datos y nunca afectará una validación o alguna otra operación no relacionada con el formato.

Si este valor es desconocido, se debe omitir (en lugar de especificar una configuración predeterminada posiblemente incorrecta).

Ejemplos: "zh-Hant", "ja", "ja-Latn", "en".

string

Opcional: Código postal de la dirección. No todos los países usan o exigen la presencia de códigos postales, pero en los lugares donde se usan, es posible que activen una validación adicional con otras partes de la dirección (p. ej., validación del código postal o el estado en EE.UU.).

string

Opcional: Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se utiliza, el valor es una cadena como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7"), o solo un número, que representa el "código de sector" (Jamaica), "indicador del área de entrega" (Malaui) o "indicador de oficina de correos" (p.ej., Costa de Marfil).

string

Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región. Por ejemplo, puede ser un estado, una provincia, una óblast o una prefectura. Específicamente, en el caso de España, corresponde a la provincia y no a la comunidad autónoma (p.ej., "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. P. ej., en Suiza se dejaría vacío.

string

Opcional: Por lo general, se refiere a la parte de la dirección que indica la ciudad o el pueblo. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En regiones del mundo donde las localidades no están bien definidas o no coinciden bien con esta estructura, deja la localidad vacía y usa addressLines.

string

Opcional: Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos.

string

Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección.

Debido a que los valores de addressLines no tienen información de tipo y, a veces, pueden contener varios valores en un solo campo (p. ej., "Austin, TX"), es importante que el orden de las líneas sea claro. El orden de las líneas de dirección debe ser el "orden de sobre" que se usa en el país o la región de la dirección. En lugares donde esto puede variar, (p. ej., Japón), address_language se usa para hacerlo explícito (p. ej., "ja" para ordenar de mayor a menor en "ja-Latn" o "en" para indicar de menor a mayor). De esta manera, se puede seleccionar la línea más específica de una dirección a partir del idioma.

La representación estructural mínima que se permite para una dirección consiste en un regionCode con toda la información restante incluida en addressLines. Sería posible dar un formato a una dirección así de manera muy aproximada sin codificación geográfica, pero no podría realizarse un análisis semántico de ningún componente de la dirección hasta que se resuelva, al menos, de manera parcial.

Crear una dirección que solo contiene regionCode y addressLines, y luego realizar la codificación geográfica es la manera recomendada de controlar direcciones sin estructura alguna (en lugar de inferir qué partes de la dirección deben ser localidades o áreas administrativas).

string

Opcional: El destinatario en la dirección. Es posible que este campo contenga varias líneas de información en ciertas circunstancias. Por ejemplo, puede contener información sobre la entrega "por medio de".

string

Opcional: El nombre de la organización de la dirección.