postalAreas

Arguments

postcode : String!


            required

Returns

[PostalArea]!

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.
KT-JP-4601: Postcode invalid.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

(No)

Query Complexity

Examples

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.

query PostalAreas($postcode: String!) {
  postalAreas(postcode: $postcode) {
    area
    city
    postcode
    prefecture
  }
}

{
  "postcode": "spring-and-million-since-again"
}

{
  "data": {
    "postalAreas": [
      {
        "area": "teacher-letter-reveal-coach-card",
        "city": "no-step-side-PM-yeah",
        "postcode": "sort-network-recognize-recognize-space",
        "prefecture": "many-everything-up-else-evidence"
      }
    ]
  }
}