{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dhl/json-schema/dhl-neighbourhood-data-rep-schema.json",
  "title": "NeighbourhoodDataRep",
  "description": "Neighbourhood data representation",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dhl-deutsche-post-print-mailing-targeting-post-parcel-germany-openapi.yml#/components/schemas/NeighbourhoodDataRep",
  "type": "object",
  "properties": {
    "neighbourhoodId": {
      "type": "string",
      "description": "Unique neighbourhood id. Matches the id returned by /neighbourhood/search and can be used directly to create a DIS selection."
    },
    "neighbourhood": {
      "type": "string",
      "description": "Neighbourhood name"
    },
    "postalCode": {
      "type": "string",
      "description": "Postal code or zip code"
    },
    "city": {
      "type": "string",
      "description": "City name"
    },
    "deliveryDistrict": {
      "type": "string",
      "description": "Delivery district (ZBN)"
    },
    "deliveryBaseId": {
      "type": "string",
      "description": "Delivery base identification number (ZBN)"
    },
    "deliveryBasePostalCode": {
      "type": "string",
      "description": "Postal code of the delivery base (ZSP)"
    },
    "deliveryBaseName": {
      "type": "string",
      "description": "Name of the delivery base (ZSP)"
    },
    "hh": {
      "type": "integer",
      "format": "int32",
      "description": "Number of households"
    },
    "hhBrutto": {
      "type": "integer",
      "format": "int32",
      "description": "Number of households brutto, thus the maximum quantity of reachable households.Authority ROLE_DIS_POSTAKTUELL_ANY_AND_ALL_HOUSEHOLDS is needed to see this value."
    },
    "ags": {
      "type": "string",
      "description": "Community identification number or Amtlicher Gemeindeschlüssel"
    },
    "tariffZone": {
      "type": "string",
      "description": "Tariff zone of the neighbourhood"
    }
  }
}