> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/checklists/change-in-the-semantics-of-the-externalid-field-in-the-division-directory.md).

# Change in the Semantics of the externalId Field in the Division Directory

From **January 1**, **2027**, the internal logic and purpose of the `externalId` field in the response of the `GET /v.1.0/divisions` method will change.

To ensure the stable operation of your integration, please note that the `externalId` field is an internal service attribute. To avoid issues in the future, it is **strongly recommended not to**:

* use it to identify divisions;
* store it as a permanent unique key in the database;
* pass it as an input parameter to other API methods.

The `externalId` field will remain in the response structure; however, its format, value, and purpose may change in the future.

#### Recommended Actions to Update the Integration

The `items[].id` field is intended to identify divisions in the system.

If your integration currently uses `externalId`, complete the following steps by **January 1**, **2027**:

* **Update the directory:** Send a `GET /v.1.0/divisions` request and retrieve the current list of divisions. For details, see [Directories | API Docs | NovaPost](https://api-portal.novapost.com/methods/methods/dictionaries#get-divisions) or the offline directory [Directories | API Docs | NovaPost](https://api-portal.novapost.com/methods/methods/dictionaries#get-dictionary-divisions).
* **Switch to the correct ID:** Store the `items[].id` field as the primary division identifier in your system.
* **Update requests:** Replace `externalId` with the corresponding `id` value in requests for creating shipments and searching for divisions.

For example, the response to the `GET /v.1.0/divisions` request contains the `id = 4493` value, which must be stored:

```json
{
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "from": null,
    "to": null,
    "items": [
        {
            "id": 4493,
            "name": "Пункт приймання-видачі (до 30 кг): вул. Шкільна, 152",
            "shortName": "Пункт приймання-видачі (до 30 кг): вул. Шкільна, 152",
            "externalId": "7ce49933-9912-11ea-a768-b8830365bd14",
            "source": "NPUA",
            "countryCode": "UA",
            "settlement": {
                "id": 122776,
               "name": "village Myliach",
"region": {
                    "id": 864,
                    "name": "Dubrovytskyi raion",
                    "parent": {
                        "id": 413,
                        "name": "Rivnenska oblast"
                    }
               }
            }

```

In the `POST /v.1.0/shipments` request for creating a shipment, pass "divisionId": 4493:

```json
{
  "status": "ReadyToShip",
  "clientOrder": "",
  "note": "",
  "payerType": "Sender",
  "invoice": null,
  "services": [],
  "parcels": [
    {
      "cargoCategory": "parcel",
      "number": null,
      "parcelDescription": "parcel for redirect test",
      "insuranceCost": 100,
      "rowNumber": 1,
      "width": 200,
      "length": 350,
      "height": 100,
      "actualWeight": 2000,
      "volumetricWeight": 2000
    }
  ],
  "sender": {
    "companyTin": "",
    "companyName": "",
    "phone": "380007654321",
    "email": "sender@test.com",
    "name": "Maks Tester",
    "countryCode": "UA",
    "divisionId": 4493,
    "addressParts": {}
  },
  "recipient": {
    "companyTin": "",
    "companyName": "",
    "phone": "380001234567",
    "email": "recipient@test.com",
    "name": "Chuck Norris",
    "countryCode": "PL",
    "divisionId": 27255,
    "addressParts": {}
  }
}
```

**Important for Legacy Integrations in Ukraine**

If your system uses the recipient address identifier (REF) or parcel locker identifier to create shipments in legacy integrations in Ukraine, this value is available in the additional parameters object returned by the `GET /v.1.0/divisions` endpoint at the following path:

`items[].additionalIds[type="InternetAddress"].value`

Example:

```json
            "additionalIds": [
                {
                    "type": "InternetAddress",
                    "partner": "NPUkraine",
                    "countryCode": "UA",
                    "value": "7ce49933-9912-11ea-a768-b8830365bd14"
                }
            ],
```

**Recommendation:** To ensure stable and long-term operation, we recommend switching to the [updated API endpoints for shipments](https://api-portal.novapost.com/methods/methods/shipments): [Shipments | API Docs | NovaPost](https://api-portal.novapost.com/methods/methods/shipments) and using `items[].id` as the **divisionId**.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://api-portal.novapost.com/checklists/change-in-the-semantics-of-the-externalid-field-in-the-division-directory.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
