Skip to main content

Address

A street oriented addressing structure supporting delivery

addressLines object[]

Address lines

  • Array [
    • orderintegerrequired

    the sequence order that the address line element should be displayed in

    Possible values: >= 0

    text object[]required

    Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

    Possible values: >= 1

  • Array [
    • languageLanguageCode (string)required

    ISO 639-1:2002 language code

    Possible values: Value must match regular expression ^[a-z]{2}$

    Example: en
    stringstringrequired

    Translated string

  • ]
    • typeAddressLineTypeEnum (string)required

    A table of types of address lines

    • apartment: Element indicating a discrete element of a building forming the address
    • building: Element identifying the number or name and type of the edifice or construction relevant for the address [derived from ISO19160-4]
    • districtTerritory: Element specifying the geographic or administrative area of the country for the address [Source: 19160-4]
    • floor: Element indicating the floor or level on which a delivery point is located in a multi-storey building [Source:ISO19160-4]
    • poBox: A postal delivery location identifier, not necessarily a physical location.
    • region: Element indicating the name of the area within or adjacent to the town in which delivery address is.
    • street: Element indicating road or street identifier or name
    • town: Element indicating the name of the populated place in which a delivery point is located, or near to or via which the delivery point is accessed. [Source: ISO19160-4]
    • unit: An element representing a section of a building or organisation.Free-text description of the condition that leads to a surcharge beingapplied

    Possible values: [apartment, building, districtTerritory, floor, poBox, region, street, town, unit]

  • ]
    • city object[]

    Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

    Possible values: >= 1

  • Array [
    • languageLanguageCode (string)required

    ISO 639-1:2002 language code

    Possible values: Value must match regular expression ^[a-z]{2}$

    Example: en
    stringstringrequired

    Translated string

  • ]
    • countryCodeCountryCode (string)

    EN ISO 3166-1 two-character country code.

    Possible values: Value must match regular expression ^[a-z]{2}$

    Example: es
    postCodestring

    Postcode or postal code for the address.

    Address
    {
      "addressLines": [
        {
          "order": 0,
          "text": [
            {
              "language": "en",
              "string": "string"
            }
          ],
          "type": "apartment"
        }
      ],
      "city": [
        {
          "language": "en",
          "string": "string"
        }
      ],
      "countryCode": "es",
      "postCode": "string"
    }