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

Запрос позволяет получить:
  • полное название адреса, города или улицы по заданной строке;
  • почтовый индекс по заданному названию города.

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

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

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

secret_key=<секретный ключ>
&client_id=<идентификатор аккаунта в Яндекс.Доставке>
&sender_id=<идентификатор магазина>
&type=<объект дополнения>
&term=<строка для дополнения>
&locality_name=<название города>
&street=<название улицы>

Параметры:

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

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

client_id Число

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

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

sender_id Число

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

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

type Строка

Объект, название которого нужно дополнить.

Допустимые значения:
  • address — почтовый адрес.
  • locality — город.
  • street — улица.
  • house — номер дома.
  • index — почтовый индекс.
  • goods — наименование товара из прайс-листа, импортированного в Яндекс.Доставку.
term Строка

Строка, которую нужно дополнить.

Параметр обязателен, если type принимает одно из значений: address, locality, street, house или goods.

locality_name Строка

Название города.

Параметр обязателен, если type принимает одно из значений: street, house или index.

street Строка

Название улицы.

Уточняющий параметр для дополнения номера дома и определения индекса.

Параметр обязателен, если type принимает значение house или index.

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

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

client_id Число

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

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

sender_id Число

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

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

type Строка

Объект, название которого нужно дополнить.

Допустимые значения:
  • address — почтовый адрес.
  • locality — город.
  • street — улица.
  • house — номер дома.
  • index — почтовый индекс.
  • goods — наименование товара из прайс-листа, импортированного в Яндекс.Доставку.
term Строка

Строка, которую нужно дополнить.

Параметр обязателен, если type принимает одно из значений: address, locality, street, house или goods.

locality_name Строка

Название города.

Параметр обязателен, если type принимает одно из значений: street, house или index.

street Строка

Название улицы.

Уточняющий параметр для дополнения номера дома и определения индекса.

Параметр обязателен, если type принимает значение house или index.

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

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

secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=3&term=%D0%BD%D0%BE%D0%B2%D0%BE%D0%BA&type=locality
cURL
curl  -d 'secret_key=6f08ebd49a996fcb6666fc130f491a2d&client_id=79&sender_id=3&term=%D0%BD%D0%BE%D0%B2%D0%BE%D0%BA&type=locality' 'https://delivery.yandex.ru/api/last/autocomplete'

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

{
  "status":"ok",
  "data":
    {
      "suggestions":
        [
          {
            "label":"Моск",
            "value":"Москва",
            "geo_id":"213"
          },
          ...
        ]
    }
}
Ключ Тип значения Описание
status Строка

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

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

Заданная строка.

value Строка

Результат дополнения.

geo_id Строка Идентификатор населенного пункта.
Ключ Тип значения Описание
status Строка

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

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

Заданная строка.

value Строка

Результат дополнения.

geo_id Строка Идентификатор населенного пункта.