Input fields

administrativeArea : String! required

都道府県 (prefecture).
country : String! required default: JP

The country code.
deliveryPointIdentifier : String

Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point.

This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers.
dependentLocality : String

UK dependent localities, or neighbourhoods or boroughs in some other locations.
geographicalId : String

Identifier for this address in its territory's official address register, e.g. DAR ID in DK, UPRN in GB, G-NAF ID in AU.
locality : String! required

市町村 (locality).
name : String

A personal name.
organization : String

The name of a business or organisation.
postalCode : String! required

郵便番号 (postcode).
sortingCode : String

Sorting code, e.g. FR CEDEX code. This field is not used in many countries.
streetAddress : String

At most one of this field and structured_street_address can be supplied.

This is a divergence from RichAddressType.street_address, where the field is always supplied; if structured_street_address is present, it's generated from that.
structuredStreetAddress : JpnRichStructuredAddressInput

At most one of this field and street_address can be supplied.

JP: Japan

The following keys may be present; all are optional. If keys are empty, they may be omitted from the response entirely.

  • chome
  • banchi
  • go
  • edaban
  • kana_building_name
  • kanji_building_name
  • building_number
  • room_number
  • address_code
  • physical_location_identifier
  • kana_company_name
  • kanji_company_name
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "administrativeArea": "professional-blue-clear-style-have", "country": "run-light-final-summer-pass", "deliveryPointIdentifier": "87601456", "dependentLocality": "hour-color-maybe-word-side", "geographicalId": "82426227", "locality": "turn-nature-identify-gas-suggest", "name": "government-travel-process-participant-role", "organization": "himself-tax-west-voice-mention", "postalCode": "can-since-day-wear-loss", "sortingCode": "half-never-wait-including-spend", "streetAddress": "increase-ability-music-skill-former", "structuredStreetAddress": JpnRichStructuredAddressInput }