Поиск по сайту

API
Главная / API - Адреса

Адреса

Обновлено 21.10.2020
158 кб

Общие сведения

Сервис позволяет получить список адресов контрагента, а также добавлять и редактировать адреса в списке.

Список адресов

Запрос метода

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

Адрес метода: https://api.dellin.ru/v2/book/addresses.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentID":1
}

Адрес метода: https://api.dellin.ru/v2/book/addresses.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <counteragentID>1</counteragentID>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

counteragentID

ДаintegerID контрагента, по которому нужно получить информацию об адресах

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "address":{
            "id":1,
            "juridical":false,
            "cityID":"200601",
            "code":"7800000000002080000000000",
            "address":"190000, г. Санкт-Петербург, Васи Алексеева ул, д. 125 кв/оф. 513",
            "street":"Васи Алексеева",
            "house":"125",
            "building":"",
            "structure":"",
            "flat":"513",
            "contacts":2,
            "phones":4,
            "regionName":"Санкт-Петербург",
            "cityName":"Санкт-Петербург г",
            "cityCode":"7800000000000000000000000",
            "terminalUID":"0xa8e2001438c4d49511db5ab084a0d1bc",
            "terminalID":1
         }
      },
      {
         "address":{
            "id":2,
            "juridical":true,
            "cityID":"588381",
            "code":"7700000000007000000000000",
            "address":"107078, г. Москва Академика Сахарова пр-кт, д. 34",
            "street":"Академика Сахарова",
            "house":"34",
            "building":"",
            "structure":"",
            "flat":"",
            "contacts":1,
            "phones":2,
            "regionName":"г. Москва",
            "cityName":"Москва г",
            "cityCode":"7700000000000000000000000",
            "terminalUID":null,
            "terminalID":null
         }
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <address>
         <id>1</id>
         <juridical>false</juridical>
         <cityID>200601</cityID>
         <code>7800000000002080000000000</code>
         <address>190000, г. Санкт-Петербург, Васи Алексеева ул, д. 125 кв/оф. 513</address>
         <street>Васи Алексеева</street>
         <house>125</house>
         <building></building>
         <structure></structure>
         <flat>513</flat>
         <contacts>2</contacts>
         <phones>4</phones>
         <regionName>Санкт-Петербург</regionName>
         <cityName>Санкт-Петербург г</cityName>
         <cityCode>7800000000000000000000000</cityCode>
         <terminalUID>0xa8e2001438c4d49511db5ab084a0d1bc</terminalUID>
         <terminalID>1</terminalID>
      </address>
   </data>
   <data>
      <address>
         <id>2</id>
         <juridical>true</juridical>
         <cityID>588381</cityID>
         <code>7700000000007000000000000</code>
         <address>107078, г. Москва Академика Сахарова пр-кт, д. 34</address>
         <street>Академика Сахарова</street>
         <house>34</house>
         <building></building>
         <structure></structure>
         <flat></flat>
         <contacts>1</contacts>
         <phones>2</phones>
         <regionName>г. Москва</regionName>
         <cityName>Москва г</cityName>
         <cityCode>7700000000000000000000000</cityCode>
         <terminalUID />
         <terminalID />
      </address>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generatedAtstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataСведения об адресах контрагента

Data
Data
ПараметрТипОписание
addressobjectИнформация об адресе
address.idintegerID адреса
address.juridicalboolead

Тип адреса.

Доступные значения:

  • "false" - адрес доставки;
  • "true" - юридический адрес
address.cityIDstringID города в "Справочнике населенных пунктов"
address.codestringКод КЛАДР улицы для адреса, если она добавлена из справочника. В противном случае - код КЛАДР населенного пункта
address.addressstringТекстовое представление адреса
address.streetstringУлица
address.housestringНомер дома, включая литеру. Например, "13/А"
address.buildingstring

Корпус

address.structurestringСтроение
address.flatstringНомер квартиры/офиса. Допускается написание с буквой, например "222 А"
address.contactsintegerКоличество контактных лиц для адреса
address.phonesintegerКоличество контактных телефонов для адреса
address.regionNamestringРегион
address.cityNamestringГород
address.cityCodestringКод КЛАДР населённого пункта из "Справочника населённых пунктов"
address.terminalUIDstringUID терминала, если адрес не является терминалом, то значение параметра - "null"
address.terminalIDintegerID терминала из "Справочника терминалов", если адрес не является терминалом, то значение параметра - "null"

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Создание и редактирование адреса

Сервис позволяет добавлять/редактировать только данные об адресе доставки. Юридический адрес можно добавить/отредактировать исключительно при помощи метода "Создание и редактирование контрагента".

Запрос метода

Пример запроса (создание адреса)

Адрес метода: https://api.dellin.ru/v2/book/address/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentID":1,
   "search":"Омск, Ленина, 5",
   "street":"7800000000004380000000000",
   "house":"4",
   "building":"3",
   "structure":"лит. А",
   "flat":"214а"
}

Адрес метода: https://api.dellin.ru/v2/book/address/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <counteragentID>1</counteragentID>
   <search>Омск, Ленина, 5</search>
   <street>7800000000004380000000000</street>
   <house>4</house>
   <building>3</building>
   <structure>лит. А</structure>
   <flat>214а</flat>
</request>

Пример запроса (создание адреса на основе терминала)

При необходимости можно создать адрес на основе терминала компании "Деловые Линии". Вся информация об адресе в данном случае будет заполнена автоматически. Получить ID терминала можно из "Справочника терминалов". Пример запроса для данного случая представлен ниже.

Адрес метода: https://api.dellin.ru/v2/book/address/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentID":1,
   "terminalID":39
}

Адрес метода: https://api.dellin.ru/v2/book/address/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <counteragentID>1</counteragentID>
   <terminalID>39</terminalID>
</request>

Пример запроса (редактирование адреса)

Для редактировании адреса запрос аналогичен запросу для создании адреса, но из параметров адреса в этом случае достаточно передать только те, которые требуется отредактировать. Например, если требуется изменить только номер дома, то в запросе достаточно передать только набор параметров, представленный ниже.

Адрес метода: https://api.dellin.ru/v2/book/address/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":1,
   "house":"12"
}

Адрес метода: https://api.dellin.ru/v2/book/address/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <addressID>1</addressID>
   <house>12</house>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

counteragentID

Нет*integer

ID контрагента, для которого нужно добавить адрес.

*Параметр является обязательным при создании адреса. При редактировании адреса параметр не используется

search

Нет (1)stringАдрес в виде произвольной строки. Минимум 2 символа, максимум - 1024 (2)
streetНет (1)string

Код КЛАДР улицы. Код КЛАДР может быть получен с помощью сервисов, представленных на странице "Использование кодов КЛАДР" (2)

houseНет (1)string

Номер дома, включая литеру. Например, "13/А" (2).

Максимум 7 символов

buildingНетstring

Корпус (2).

Максимум 5 символов

structureНетstring

Строение (2).

Максимум 7 символов

flatНетstring

Номер квартиры/офиса. Допускается написание с буквой, например "222 А" (2).

Максимум 5 символов

terminalIDНет (1)integer

ID терминала из "Справочника терминалов". Параметр используется для создания адреса на основе терминала компании "Деловые Линии". Вся информация об адресе в данном случае заполняется автоматически (2)

addressIDНет*integer

ID адреса, который нужно изменить.

*Параметр является обязательным при редактировании адреса. При создании адреса параметр не используется

Примечания:

  1. При создании адреса обязательно должны быть переданы данные адреса - в виде произвольной строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house") или ID терминала ("terminalID").
  2. Передача параметра "search" или параметра "terminalID" исключает передачу параметров "street", "house", "building", "structure" и "flat"

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "state":"existing",
      "addressID":1,
      "foundAddresses":[
         {
            "source":"Омск, Ленина, 5",
            "result":"Россия, Омская обл, г Омск, ул Ленина, д 5"
         }
      ]
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>existing</state>
      <addressID>1</addressID>
      <foundAddresses>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generatedAtstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация об отредактированном/добавленном адресе
data.statestring

Статус адреса. Возможные значения:

  • "existing" - отредактирован существующий адрес;
  • "new" - создан новый адрес
data.addressIDintegerID отредактированного/добавленного адреса
data.foundAddressesarray of FoundAddressesДанные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "search"

FoundAddresses
FoundAddresses
ПараметрТипОписание
sourcestring

Введённое значение

resultstring

Найденный адрес

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".