Offline reference guide for clients containing the list of settlements in Ukraine where shipment del

Method name	Settlement Prohibited Issuance Dictionary
HTTP Method	Returns a manifest with links to offline files containing settlements where shipment is prohibited to deliver in Ukraine.
Route	GET /api.novapost.pl/v.1.0/dictionary/settlements/prohibited-issuance
Autorization	Authorization: JWT

Description

This API provides a daily-updated manifest of Ukrainian settlements where shipment delivery is prohibited. The manifest includes links to localized, gzipped JSON files with detailed settlement information and prohibition flags.

The files are available in both Ukrainian and English for localization support.

The files are updated each day at 5:00 UTC.

Features:

• Returns a JSON manifest with URLs to the updated settlement lists.
• Each list is a gzipped JSON file (.json.gz).
• Each file is localized (locale="uk" for Ukrainian, locale="en" for English).
• Settlement records include administrative region, coordinates, postal codes, alternative names, and prohibition flags.

Request headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer <token>. Auth token of the client.

Response Example

https://api-portal.novapost.com/methods/methods/dictionaries

{
    "unix_time": 1766120417,
    "urls": [
        "https://api-cdn.novapost.com/dictionary/settlements/prohibited-issuance/en/settlements.json.gz",
        "https://api-cdn.novapost.com/dictionary/settlements/prohibited-issuance/uk/settlements.json.gz"
    ]
}

Use the URLs provided in the manifest to download the latest settlement lists for each supported locale.

Example of settlement structure in JSON (en locale)

[
  {
    "id": 108335,
    "name": "urban villagе Abrykosivka",
    "country": {
      "code": "UA",
      "name": "Ukraine"
    },
    "region": {
      "id": 964,
      "name": "Oleshkivskyi raion",
      "parent": {
        "id": 417,
        "name": "Khersonska oblast"
      }
    },
    "latitude": 46.488153,
    "longitude": 33.071226,
    "postCode1": "75134",
    "postCode2": "75134",
    "alternativeNames": [
      "abrykosivka",
      "селище абрикосівка",
      "selishche abrikosivka",
      "поселок абрикосовка",
      "poselok abrikosovka",
      "urban villagе abrykosivka",
      "urban village abrykosivka"
    ],
    "externalId": "0ddee0f8-4b3a-11e4-ab6d-005056801329",
    "prohibitedSending": false,
    "prohibitedIssuance": true
  }
  ]

Schema

Settlement Object Schema

Acceptable HTTP status codes response

HTTP-code	Status	Description
200	OK	Request successful. The server has responded as required.
404	Not Found	ErrorMessage: "Action_not_available"

cURL

curl --location 'https://api-stage.novapost.pl/v.1.0/dictionary/settlements/prohibited-issuance' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InByaXZhdGU6MmU1OWI1ZjEtYzIwYS00MWFlLTk3N2ItYzU5MWJiZmY2ODA5IiwidHlwIjoiSldUIn0.eyJhdF9oYXNoIjoiRG9SNVU5MmNaakRQT0dUbDJuWU94QSIsImF1ZCI6WyJmZWU5dVlpYUFoVzBvcG9vLmF1dGguYXBwcy5ub3ZhcG9zdC5jb20iXSwiYXV0aF90aW1lIjoxNzY2NDkxMTg3LCJjb3VudHJ5X2NvZGUiOiJVQSIsImVtYWlsIjoiIiwiZXhwIjoxNzY3MDk2MDI5LCJpYXQiOjE3NjY0OTEyMjksImlzcyI6Imh0dHBzOi8vYXV0aC1zdGFnZS5ub3ZhcG9zdC5jb20vIiwianRpIjoiZDVkOWZiNmItYmNlNy00YWYyLTgyMGYtYWQ5MGMxODQwMTI3IiwibmFtZSI6ItCQ0LzQsdGA0L7RgSDQnNCw0YDRltCw0L3QvdCwINCS0ZbQtNGB0YPRgtC90ZQiLCJwYXJ0bmVySW5mbyI6eyJjb3VudHJ5Q29kZSI6IiIsImRpdmlzaW9uSWQiOjAsInJvbGVzIjpudWxsfSwicGhvbmUiOiIzODA5MzkxNTM3OTkiLCJyYXQiOjE3NjY0OTExNjQsInJlZ2lvbl9jb2RlIjoiVUEiLCJzaWQiOiIxNGRjN2JmOC01YTUwLTRhM2MtYWE3My03ZjhkYjdkNjAwOTgiLCJzdWIiOiJlZjA0ZDZlZS0xNjE0LTQ5YzAtYmFiYS01NmY1NzQ2OThjNWEifQ.H5DNONyaiiA4kM7mkLK_AEFCCptJmjUg-8VcSm-eEsQ-ijt-PC3UXljlcyKpc1RF12ZtJhBPls1qiwh26PnFC8_cabE1N-XR-U6NpAlxC20hc0Ik5EFI9YMmfuJTQhVH1TwlFTo4TFmDO6Bf-UG5hrfwiw3dDRs-rs-Ql8SXKGvLx6_h8421rCaNKUoX--D4drMJjHljR82FyKnrSfdeu8E9MFHp5KeIEm6cwYasTPNEaHTK_njorlqvPFjvdIGHc9XpQv8naHQtDJJdb08LM2jbFApm86ceHRlmOUvEe2vZuWQgbcdhDUQYtLUlxboltlq6WGxq7IaooEXprt_ihRMkwHMvNyoqo4Wv7ZTUv2vi0zT7rtqlGHRsjPTMTtvH1lVMJEIsMy1nQL1aAr8gfKzU2Bt_B4zyBahu58TLtWhs1y27dZCmuXye8tdwnjAA5kwTxgNYXryZSwxepGyyH4m-mP_gUdY5rxgSbFQwIUyOsK9lr0avqob17860LqTHnUtLNykH6S9-95h1HWzJ8L4HE1ml_a2OtwGPo_dkkq4kt1AfSZF_sCCovHNoS4BlVVHuVK6WWD-SVc01WauNG4dwm5L3jxIyb79QuI52G93zqEy_h4LBBVf22jnTVjRzOCywcWAKVO0zDPkkK-KuNinqVvlVkWiffBNtDnK-fwY'