Получить индекс по адресу

Запрос позволяет определить почтовый индекс по заданному адресу.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

Синтаксис запроса

POST /api/last/getIndex
Host: delivery.yandex.ru 
Content-Type:application/x-www-form-urlencoded
... 

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&address=<адрес>

Параметры:

Параметр Тип Значение
Обязательные
secret_key Строка

Секретный ключ.

client_id Число

Идентификатор аккаунта в Яндекс.Доставке.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

sender_id Число

Идентификатор магазина.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

address Строка

Почтовый адрес.

Полный адрес можно получить с помощью запроса Получить полный адрес.

Параметр Тип Значение
Обязательные
secret_key Строка

Секретный ключ.

client_id Число

Идентификатор аккаунта в Яндекс.Доставке.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

sender_id Число

Идентификатор магазина.

Значение можно получить в личном кабинете Яндекс.Доставки, в разделе Настройки, на вкладке Интеграция → API.

address Строка

Почтовый адрес.

Полный адрес можно получить с помощью запроса Получить полный адрес.

Пример запроса

POST /api/last/getIndex HTTP/1.1
Host: delivery.yandex.ru
Content-Type:application/x-www-form-urlencoded
...
 
secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=3&address=+%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0%2C+%D1%83%D0%BB.+%D0%9B%D1%8C%D0%B2%D0%B0+%D0%A2%D0%BE%D0%BB%D1%81%D1%82%D0%BE%D0%B3%D0%BE%2C+%D0%B4.+16
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=3&address=+%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D0%B0%2C+%D1%83%D0%BB.+%D0%9B%D1%8C%D0%B2%D0%B0+%D0%A2%D0%BE%D0%BB%D1%81%D1%82%D0%BE%D0%B3%D0%BE%2C+%D0%B4.+16' 'https://delivery.yandex.ru/api/last/getIndex'

Структура ответа

{
  "status":"ok",
  "data":
    {
      "label":"124365",
      "value":"124365",
      "locality_name":"Кутузово",
      "correction_address":"Балаклавская 5"
    }
}
Ключ Тип значения Описание
status Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Объект Данные ответа.
Ключи объекта data
label Строка Почтовый индекс.
value Строка

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

locality_name Строка

Название населенного пункта.

correction_address Строка

Почтовый адрес.

Ключ Тип значения Описание
status Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
data Объект Данные ответа.
Ключи объекта data
label Строка Почтовый индекс.
value Строка

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

locality_name Строка

Название населенного пункта.

correction_address Строка

Почтовый адрес.