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

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

Адреса

Обновлено 09.08.2017
118 кб

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

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

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

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

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

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

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

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragentid>1</counteragentid>
</request>

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

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

sessionID

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

counteragentID

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

Ответ метода

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

[  
   {  
      "address":{  
         "id":"1",
         "type":"delivery",
         "cityID":"200601",
         "code":"7800000000002080000000000",
         "address":"190000, г. Санкт-Петербург, Васи Алексеева ул, д. 125 кв/оф. 513",
         "street":"Васи Алексеева",
         "house":"125",
         "building":"",
         "structure":"",
         "flat":"513",
         "contacts":2,
         "phones":4
      }
   },
   {  
      "address":{  
         "id":"2",
         "type":"juridical",
         "cityID":"7656",
         "code":"1600000100000790000000000",
         "address":"420000, Казань г (Респ. Татарстан), Мусы Бигиева ул, д. 122",
         "street":"Мусы Бигиева",
         "house":"122",
         "building":"",
         "structure":"",
         "flat":"",
         "contacts":1,
         "phones":2
      }
   },
   {  
      "address":{  
         "id":"3",
         "type":"delivery",
         "cityID":"73293",
         "code":"4000000100002180000000000",
         "address":"248031, Калуга г (Калужская обл.), Майская ул, д. 124",
         "street":"Майская",
         "house":"124",
         "building":"",
         "structure":"",
         "flat":"",
         "contacts":1,
         "phones":1
      }
   }
]
<response>
   <address>
      <id>1</id>
      <type>delivery</type>
      <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>
   </address>
   <address>
      <id>2</id>
      <type>juridical</type>
      <cityid>7656</cityid>
      <code>1600000100000790000000000</code>
      <address>420000, Казань г (Респ. Татарстан), Мусы Бигиева ул, д. 122</address>
      <street>Мусы Бигиева</street>
      <house>122</house>
      <building></building>
      <structure></structure>
      <flat></flat>
      <contacts>1</contacts>
      <phones>2</phones>
   </address>
   <address>
      <id>3</id>
      <type>delivery</type>
      <cityid>73293</cityid>
      <code>4000000100002180000000000</code>
      <address>248031, Калуга г (Калужская обл.), Майская ул, д. 124</address>
      <street>Майская</street>
      <house>124</house>
      <building></building>
      <structure></structure>
      <flat></flat>
      <contacts>1</contacts>
      <phones>1</phones>
   </address>
</response>

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

Response
ПараметрТипОписание
addressobjectИнформация об адресе
address.idstringID адреса
address.typestring

Тип адреса.

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

  • "delivery" - адрес доставки
  • "juridical " - юридический адрес
address.cityIDstringID города в "Справочнике населенных пунктов"
address.codestringКод КЛАДР улицы для адреса, если она добавлена из справочника. В противном случае - код КЛАДР населенного пункта
address.addressstringТекстовое представление адреса
address.streetstringУлица
address.housestringНомер дома, включая литеру. Например, "13/А"
address.buildingstringКорпус (числовое значение)
address.structurestringСтроение (числовое значение)
address.flatstringКвартира/офис. Допускается написание с буквой, например "222 А"
address.contactsintegerКоличество контактных лиц для адреса
address.phonesintegerКоличество контактных телефонов для адреса

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

Создание адреса

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

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentID":"1",
   "street":"7800000000004380000000000",
   "house":"4",
   "building":"3",
   "structure":"лит. А",
   "flat":"214а"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragentid>1</counteragentid>
   <street>7800000000004380000000000</street>
   <house>4</house>
   <building>3</building>
   <structure>лит. А</structure>
   <flat>214а</flat>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

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

counteragentID

ДаstringID контрагента, для которого нужно добавить адрес
streetДаstringКод КЛАДР улицы
houseДаstringНомер дома
buildingНетstringКорпус
structureНетstringСтроение
flatНетstringКвартира/офис
Обратите внимание, что таким образом можно добавить только данные об адресе доставки. Юридический адрес можно добавить исключительно через изменение данных контрагента.

Если по какой-либо причине код КЛАДР улицы определить нельзя, то запрос должен иметь вид, представленный ниже.

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

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

{
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "counteragentID":"1",
   "customStreet":{  
      "code":"7800000000000000000000000",
      "street":"Какая-то другая улица"
   },
   "house":"4",
   "building":"",
   "structure":"",
   "flat":""
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragentid>1</counteragentid>
   <customStreet>
      <code>7800000000000000000000000</code>
      <street>Какая-то другая улица</street>
   </customStreet>
   <house>4</house>
   <building></building>
   <structure></structure>
   <flat></flat>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

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

counteragentID

ДаstringID контрагента, для которого нужно добавить адрес
customStreetДаobjectИнформация об улице
customStreet.codeДаstringКод КЛАДР населенного пункта
customStreet.streetДаstringТекстовое представление улицы
houseДаstringНомер дома
buildingНетstringКорпус
structureНетstringСтроение
flatНетstringКвартира/офис
Не следует использовать этот способ добавления адреса, если выбранная Вами улица есть в КЛАДР.

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

Пример запроса для данного случая представлен ниже.

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

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

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

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <counteragentid>1</counteragentid>
   <terminal_id>39</terminal_id>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

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

counteragentID

ДаstringID контрагента, для которого нужно добавить адрес
terminal_idДаstringID терминала из "Справочника терминалов"

Ответ метода

Пример ответа
{  
   "success":{  
      "addressID":"14"
   }
}
<response>
   <success>
      <addressid>14</addressid>
   </success>
</response>
Описание параметров
Response
ПараметрТипОписание
successobjectИнформация о добавленном адресе
success.addressIDstringID добавленного адреса

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

В случае ошибок вернется пакет с описанием ошибок.

Пример ответа
{  
   "errors":{  
      "street":"код не соответствует коду КЛАДР"
   }
}
<response>
   <errors>
      <street>код не соответствует коду КЛАДР</street>
   </errors>
</response>

Редактирование адреса

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

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

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

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

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <addressid>1</addressid>
   <house>12</house>
</request>
Описание параметров
Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

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

addressID

ДаstringID адреса, который нужно изменить
houseДаstringНовый номера дома
Ответы сервиса при редактировании адреса аналогичны ответам при создании адреса.