If you're interested in the English version of this spec, let us know on the GitHub.

postal_unit

---

Подсказки по отделениям Почты России

POST

/suggest/postal_unit

Поиск выполняется по полям:

• postal_code - индекс
• address_str - адрес

Authorizations

ApiKey

API-ключ. Полный вид заголовка: Authorization: Token <YOUR_KEY>. Получить ключ

Type

API Key (header: Authorization)

Request Body

application/json

object

See https://dadata.ru/api/suggest/postal_unit/

Адрес строкой или почтовый индекс

@example { "query": "дежнева 2а" } // по адресу
@example { "query": "105" } // все отделения с индексом, начинающимся на 105
@maxLength 300

Max Length300

Максимальное количество результатов.
@minimum 1
@maximum 20
@default 10

Minimum1

Maximum20

Default10

object[]

Фильтрация почтовых отделений

• Поля внутри одного фильтра интерпретируются как AND, между фильтрами - как OR

Фильтрация по признаку открыто/закрыто. false - искать только открытые, true - только закрытые

Фильтрация по типу отделения (например, ГОПС)

Фильтрация по населённому пункту отделения. Например '6300000100000' (КЛАД-код города)

Responses

Запрос успешно обработан

Content-Type

application/json

object

Объект с массивом подсказок

object[]

Required

Массив подсказок или пустой массив

Почтовый индекс

Адрес отделения одной строкой

object

Required

Подробности об отделении