Междугородняя перевозка еврофурой

Обновлено 21.02.2023

242 кб

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

Сервис предназначен для оформления заказов на междугороднюю перевозку выделенной еврофурой от адреса отправителя до адреса получателя (с погрузкой/выгрузкой в промежуточных точках при необходимости). Сервис доступен как авторизованным, так и неавторизованным пользователям. У авторизованных пользователей есть возможность использовать данные адресной книги, а также обновлять их при оформлении заказа.

Междугородняя перевозка еврофурой

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

Адрес метода: https://api.dellin.ru/v1/ftl/request.json

{
   "appKey":"00000000-0000-0000-0000-000000000000",
   "sessionId":"00000000-0000-0000-0000-000000000000",
   "trailerType":"tent",
   "tentRequirements":[
      "removable_rack"
   ],
   "delivery":{
      "derival":{
         "addressID":3075,
         "address":{
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"2",
            "flat":"100",
            "save":false
         },
         "time":{
            "worktimeStart":"10:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:00",
            "breakEnd":"13:00"
         },
         "documentsForReceive":[
            "0x90bc42c2d8cf7c1c47a40fc1ccfb54d5"
         ],
         "services":{
            "tentingRemoval":"side",
            "placesRecount":false
         }
      },
      "arrival":{
         "addressID":3076,
         "address":{
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"2",
            "flat":"100",
            "save":false
         },
         "time": {
            "worktimeStart":"10:00",
            "worktimeEnd":"18:00",
            "breakStart":"12:00",
            "breakEnd":"13:00"
         },
         "services":{
            "tentingRemoval":"side",
            "placesRecount":false,
            "unloadingRamp":false,
            "fridgeThermalReport":false
         }
      },
      "transit":[
         {
            "addressID":3077,
            "address":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "time":{
               "worktimeStart":"10:00",
               "worktimeEnd":"18:00",
               "breakStart":"12:00",
               "breakEnd":"13:00"
            },
            "services":{
               "tentingRemoval":"side ",
               "loadingPlacesRecount":false,
               "unloadingPlacesRecount":false,
               "unloadingRamp":false
            }
         }
      ],
      "smsback":"79503334444",
      "emailback":"examble@gmail.com",
      "comment":"Текст комментария"
   },
   "members":{
      "requester":{
         "role":"third",
         "uid":"aa00a000-a600-0000-a000-00aa0aaa0a00"
      },
      "sender":{
         "counteragentID":2010,
         "counteragent":{
            "form":"0xaa9042fea4fa169d4d021c6941f2090f",
            "name":"ИП Иванов И. И",
            "inn":"550797658844",
            "document": {
               "type":"passport ",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            12345
         ],
         "contactPersons":[
            {
               "name":"Иванов Иван",
               "save":true
            }
         ],
         "phoneID":[
            12345
         ],             
         "phoneNumbers":[
            {
               "number":"79136333344",
               "save":true
            }
         ]
      },
      "transit":[
         {
            "counteragentID":2011,
            "counteragent":{
               "form":"0xaa9042fea4fa169d4d021c6941f2090f",
               "name":"ИП Сидоров",
               "inn":"550797658833",
               "document":{
                  "type":"passport ",
                  "serial":"0000",
                  "number":"000000"
               },
               "juridicalAddress":{
                  "search":"Омск, Ленина, 5",
                  "street":"5500000100005970000000000",
                  "house":"5",
                  "building":"1",
                  "structure":"2",
                  "flat":"100",
                  "save":false
               },
               "save":false
         },
         "contactID":[
            78945
         ],
         "contactPersons":[
            {
               "name":"Петр",
               "save":true
            }
         ],
         "phoneID":[
            78945
         ], 
         "phoneNumbers":[
            {
               "number":"79131133344",
               "save":true
            }
         ]
      }],
      "receiver":{
         "counteragentID":2012,
         "counteragent":{
            "form":"0xaa9042fea4fa169d4d021c6941f2090f",
            "name":"ИП Петров",
            "inn":"550797658822",
            "document":{
               "type":"passport",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            45612
         ],
         "contactPersons":[
            {
               "name":"Иван",
               "save":true
            }
         ],
         "phoneID":[
            45612
         ], 
         "phoneNumbers":[
            {
               "number":"79132233344",
               "save":true
            }
         ]
      },
      "third":{
         "counteragentID":2013,
         "counteragent":{
            "form":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
            "name":"Шариков П. П.",
            "inn":"550797658844",
            "document":{
               "type":"passport",
               "serial":"0000",
               "number":"000000"
            },
            "juridicalAddress":{
               "search":"Омск, Ленина, 5",
               "street":"5500000100005970000000000",
               "house":"5",
               "building":"1",
               "structure":"2",
               "flat":"100",
               "save":false
            },
            "save":false
         },
         "contactID":[
            65421
         ],
         "contactPersons":[
            {
               "name":"Фёдор",
               "save":true
            }
         ],
         "phoneID":[
            65421
         ], 
         "phoneNumbers":[
            {
               "number":"79131133355",
               "save":true
            }
         ]
      }
   },
   "produceDate":"2020-04-15",
   "cargo": {
      "freightUID":"eddb67e3-bdb3-11e0-ad24-001a64963cbd"
   },
   "gpsReport":false,
   "payment":{
      "primaryPayer":"sender",
      "smsForBill":"79507878787",
      "emailForBill":"example@gmail.com"
   }
}

Адрес метода: https://api.dellin.ru/v1/ftl/request.xml

<request> 
   <appKey>00000000-0000-0000-0000-000000000000</appKey>
   <sessionId>00000000-0000-0000-0000-000000000000</sessionId>
   <trailerType>tent</trailerType>
   <tentRequirements>removable_rack</tentRequirements>
   <delivery>
      <derival>
         <addressID>3075</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <documentsForReceive>0x90bc42c2d8cf7c1c47a40fc1ccfb54d5</documentsForReceive>
         <services>
            <tentingRemoval>side</tentingRemoval>
            <placesRecount>false</placesRecount>
         </services>
      </derival>
      <arrival>
         <addressID>3076</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <services>
            <tentingRemoval>side</tentingRemoval>
            <placesRecount>false</placesRecount>
            <unloadingRamp>false</unloadingRamp>
            <fridgeThermalReport>false</fridgeThermalReport>
         </services>
      </arrival>
      <transit>
         <addressID>3077</addressID>
         <address>
            <search>Омск, Ленина, 5</search>
            <street>5500000100005970000000000</street>
            <house>5</house>
            <building>1</building>
            <structure>2</structure>
            <flat>100</flat>
            <save>false</save>
         </address>
         <time>
            <worktimeStart>10:00</worktimeStart>
            <worktimeEnd>18:00</worktimeEnd>
            <breakStart>12:00</breakStart>
            <breakEnd>13:00</breakEnd>
         </time>
         <services>
            <tentingRemoval>side </tentingRemoval>
            <loadingPlacesRecount>false</loadingPlacesRecount>
            <unloadingPlacesRecount>false</unloadingPlacesRecount>
            <unloadingRamp>false</unloadingRamp>
         </services>
      </transit>
      <smsback>79503334444</smsback>
      <emailback>examble@gmail.com</emailback>
      <comment>Текст комментария</comment>
   </delivery>
   <members>
      <requester>
         <role>third</role>
         <uid>aa00a000-a600-0000-a000-00aa0aaa0a00</uid>
      </requester>
      <sender>
         <counteragentID>2010</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Иванов И. И</name>
            <inn>550797658844</inn>
            <document>
               <type>passport </type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>1</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>12345</contactID>
         <contactPersons>
            <name>Иванов Иван</name>
            <save>true</save>
         </contactPersons>
         <phoneID>12345</phoneID>
         <phoneNumbers>
            <number>79136333344</number>
            <save>true</save>
         </phoneNumbers>
      </sender>
      <transit>
         <counteragentID>2011</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Сидоров</name>
            <inn>550797658833</inn>
            <document>
               <type>passport </type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>78945</contactID>
         <contactPersons>
            <name>Петр</name>
            <save>true</save>
         </contactPersons>
         <phoneID>78945</phoneID>
         <phoneNumbers>
            <number>79131133344</number>
            <save>true</save>
         </phoneNumbers>
      </transit>
      <receiver>
         <counteragentID>2012</counteragentID>
         <counteragent>
            <form>0xaa9042fea4fa169d4d021c6941f2090f</form>
            <name>ИП Петров</name>
            <inn>550797658822</inn>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>45612</contactID>
         <contactPersons>
            <name>Иван</name>
            <save>true</save>
         </contactPersons>
         <phoneID>45612</phoneID>
         <phoneNumbers>
            <number>79132233344</number>
            <save>true</save>
         </phoneNumbers>
      </receiver>
      <third>
         <counteragentID>2013</counteragentID>
         <counteragent>
            <form>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</form>
            <name>Шариков П. П.</name>
            <inn>550797658844</inn>
            <document>
               <type>passport</type>
               <serial>0000</serial>
               <number>000000</number>
            </document>
            <juridicalAddress>
               <search>Омск, Ленина, 5</search>
               <street>5500000100005970000000000</street>
               <building>5</building>
               <flat>1</flat>
               <house>2</house>
               <structure>100</structure>
               <save>false</save>
            </juridicalAddress>
            <save>false</save>
         </counteragent>
         <contactID>65421</contactID>
         <contactPersons>
            <name>Фёдор</name>
            <save>true</save>
         </contactPersons>
         <phoneID>65421</phoneID>
         <phoneNumbers>
            <number>79131133355</number>
            <save>true</save>
         </phoneNumbers>
      </third>
   </members>
   <produceDate>2020-04-15</produceDate>
   <cargo>
      <freightUID>eddb67e3-bdb3-11e0-ad24-001a64963cbd</freightUID>
   </cargo>
   <gpsReport>false</gpsReport>
   <payment>
      <primaryPayer>sender</primaryPayer>
      <smsForBill>79507878787</smsForBill>
      <emailForBill>example@gmail.com</emailForBill>
   </payment>
</request>

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

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Нет	string	ID сессии. Для получения сессии можно воспользоваться методом "Авторизация пользователя"
trailerType	Да	string	Тип полуприцепа. Возможные значения: "isoterm" - изотермический; "tent" - тентованный; "fridge" - рефрижераторный
tentRequirements	Нет	array of strings	Дополнительные требования к тенотованному полуприцепу (значение параметра "trailerType" - "tent"). Возможные значения: "hard_board" - жёсткий борт; "removable_beam" - съёмная верхняя балка; "removable_rack" - съёмная боковая стойка. Допускается передача нескольких значений. Если тип полуприцепа - изотермический/рефрижератор (значение параметра "trailerType" - "isoterm"/"fridge"), то параметр игнорируется
delivery	Да	object	Информация о пунктах маршрута
delivery.derival	Да	Waypoint	Информация о начальном пункте маршрута
delivery.arrival	Да	Waypoint	Информация о конечном пункте маршрута
delivery.transit	Нет	array of Waypoint	Информация о промежуточных пунктах маршрута. Максимум может быть указано 4 промежуточных пункта При заказе рефрижераторного полуприцепа (то есть если в запросе передан параметр "trailerType" со значением "fridge") погрузка/выгрузка в промежуточных пунктах недоступна
delivery.smsback	Да	string	Номер телефона для отправки SMS-уведомлений. Формат: "7XXXXXXXXXX" (11 цифр с ведущей семёркой)
delivery.emailback	Да	string	Контактный адрес электронной почты. Максимальная длина поля - 128 символов
delivery.comment	Нет	string	Комментарий к заказу. Максимальная длина поля - 500 символов
members	Да	object	Участники перевозки
members.requester	Да	Requester	Данные заказчика перевозки
members.sender	Да	Member	Данные грузоотправителя
members.transit	Нет*	array of Member	Данные контрагента в промежуточной пункте маршрута *Параметр является обязательным, если в был передан хотя бы один параметр "delivery.transitdelivery.transit". Количество элементов объекта "members.members.transit" должно совпадать с количеством элементов объекта "delivery.transit"
members.receiver	Да	Member	Данные грузополучателя
members.third	Нет	Member	Данные третьего лица
produceDate	Да	string	Дата подачи машины в начальную точку маршрута/к отправителю. Формат: ГГГГ-ММ-ДД
cargo	Да	object	Характеру груза
cargo.freightUID	Да	string	UID характера груза из справочника "Характер груза: поиск по строке (перевозка еврофурой)"
gpsReport	Нет	boolean	Флаг, обозначающий, что необходим GPS-отчёт о перевозке
payment	Да	object	Информация о плательщике
payment.primaryPayer	Да	string	Роль плательщика в перевозке Возможные значения: "sender" - отправитель; "receiver" - получатель; "third" - третье лицо
payment.smsForBill	Нет	string	Номер телефона для отправки SMS с чеком. Формат: Формат: "7XXXXXXXXXX" (11 цифр с ведущей семёркой) Параметр используется только в том случае, когда плательщик является физическим лицом
payment.emailForBill	Нет	string	Адрес электронной почты для отправки чека. Максимальная длина поля - 128 символов Параметр используется только в том случае, когда плательщик является физическим лицом

Waypoint

Waypoint
Параметр	Обязательный	Тип	Описание
addressID	Нет*	integer	ID адреса из "Адресной книги" *Если пользователь не авторизован (параметр "sessionID" отсутствует в запросе), то параметр игнорируется. Если пользователь авторизован (в запросе передан параметр "sessionID"), то передача одного из взаимоисключающих параметров "addressID" или "address" является обязательной
address	Нет*	AddressAddress	Адрес *Если пользователь не авторизован (параметр "sessionID" отсутствует в запросе), то параметр является обязательным. Если пользователь авторизован (в запросе передан параметр "sessionID"), то передача одного из взаимоисключающих параметров "addressID" или "address" является обязательной
time	Да	object	Время погрузки/разгрузки
time.worktimeStart	Да	string	Начало периода. Формат: ЧЧ:ММ
time.worktimeEnd	Да	string	Конец периода. Формат: ЧЧ:ММ
time.breakStart	Нет	string	Начало перерыва. Формат: ЧЧ:ММ
time.breakEnd	Нет	string	Окончание перерыва. Формат: ЧЧ:ММ
documentsForReceive	Да	array of stringsarray of strings	UID документа из справочника "Документы для получения груза" Данный параметр используется только для объекта "delivery.derival"
services	Да	object	Дополнительные услуги
services.tentingRemoval	Нет	string	Снятие тента. Возможные значения: "back" - задняя растентовка; "top" - верхняя растентовка; "side" - боковая растентовка; "full" - полная растентовка. Значение по умолчанию - "back" Снятие тента доступно только при заказе тентованного полуприцепа (то есть в том случае, если в запросе передан параметр "trailerType" со значением "tent"), но недоступно при заказе "жёсткого борта" (в запросе передан "tentRequirements" со значением "hard_boardhard_board")
services.placesRecount	Нет	boolean	Флаг, обозначающий, что необходим пересчёт мест в начальном/конечном пункте маршрута Параметр используется для объектов "delivery.derival" и "delivery.arrival"
services.loadingPlacesRecount	Нет	boolean	Флаг, обозначающий, что необходим пересчёт мест при загрузке в промежуточном пункте маршрута Услуга недоступна при заказе "рефрижераторного" полуприцепа (то есть в том случае, если в запросе передан параметр "trailerType" со значением "fridge").Параметр используется для только для объекта "delivery.transit"
services.unloadingPlacesRecount	Нет	boolean	Флаг, обозначающий, что необходим пересчёт мест при выгрузке в промежуточном пункте маршрута Услуга недоступна при заказе "рефрижераторного" полуприцепа (то есть в том случае, если в запросе передан параметр "trailerType" со значением "fridge").Параметр используется для только для объекта "delivery.transit"
services.unloadingRamp	Нет	boolean	Флаг, обозначающий, что потребуется выгрузка на пандус Услуга доступна при заказе "тентованного"/"изотермического" полуприцепа при условии что не запрошена услуга "верхняя растентовка" (в запросе передан параметр "trailerType" со значением "tent"/"isoterm" и отсутствует параметр "tentRequirements" со значением "top").Параметр используется для объектов "delivery.arrival" и "delivery.transit"
services.fridgeThermalReport	Нет	boolean	Флаг, обозначающий, что необходим отчёт о температурном режиме Услуга доступна только при заказа рефрижератора (то есть в том случае, если в запросе передан параметр "trailerType" со значением "fridge"). Данный параметр используется только для объекта "delivery.arrival"

Requester

Параметр

Обязательный

Тип

Описание

role

Да

string

Роль заказчика в перевозке.

Возможные значения:

"sender" - отправитель;
"receiver" - получатель;
"payer" - плательщик;
"third" - третье лицо

uid

Нет*

string

UID контрагента из справочника "Список контрагентов"

*Если пользователь авторизован (в запросе передан параметр "sessionID"), то параметр является обязательным. При этом у текущей учётной записи должен быть полный доступ к контрагенту (см. метод "Список контрагентов", описание параметра ответа "info.accessLevel")

Member

Member
Параметр	Обязательный	Тип	Описание
counteragentID	Нет*	integer	ID контрагента из "Адресной книги" *Если пользователь не авторизован, то параметр игнорируется. Если пользователь авторизован, то передача одного из взаимоисключающих параметров "counteragentID" или "counteragent" является обязательной
counteragent	Нет*	object	Данные контрагента *Если пользователь не авторизован, то параметр является обязательным. Если пользователь авторизован, то передача одного из взаимоисключающих параметров "counteragentID" или "counteragent" является обязательной
counteragent.form	Да	string	UID ОПФ (организационно-правовой формы), см. "Поиск ОПФ"
counteragent.name	Да	string	Наименование юридического лица или имя физического лица
counteragent.inn	Нет*	string	ИНН. Максимальная допустимая длина поля зависит от страны и ОПФ. Параметр используется только для юридических лиц (то есть в тех случаях, когда в качестве значения параметра "counteragent.form" передан UID ОПФ юридического лица) *Если контрагент является юридическим лицом, то параметр является обязательным
counteragent.document	Нет*	Document	Данные документа, удостоверяющего личность. Параметр используется только для физических лиц (то есть в тех случаях, когда в качестве значения параметра "counteragent.form" передан UID ОПФ физического лица) *Если контрагент является физическим лицом, то параметр является обязательным
counteragent.juridicalAddress	Нет	Address	Юридический адрес. Параметр используется только для юридических лиц (то есть в тех случаях, когда в качестве значения параметра "counteragent.form" передан UID ОПФ юридического лица)
counteragent.save	Нет	boolean	Флаг обозначающий, что данные контрагента необходимо сохранить в адресную книгу (см. методы адресной книги для работы с контрагентами) Сохранение в адресную книгу доступно только авторизованным пользователям
contactID	Нет*	array of integers	Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве - 3 *Если пользователь не авторизован, то параметр игнорируется. Если пользователь авторизован, то передача одного из взаимоисключающих параметров "contactID" или "contactPersons" является обязательной
contactPersons	Нет*	array of contactPersons	Данные контактных лиц. Для авторизованных пользователей максимальное количество элементов в массиве - 3, для неавторизванных - 1 *Параметр является обязательным для неавторизованных пользователей. Для авторизованных пользователей обязательна передача одного из взаимоисключающих параметров "contactID" или "contactPersons"
contactPersons.name	Да	string	Имя контактного лица
contactPersons.save	Нет	boolean	Флаг, обозначающий, что данные контактного лица необходимо сохранить в адресную книгу (см. методы адресной книги для работы с контактными данными). Значение по умолчанию - "false" Сохранение в адресную книгу доступно только авторизованным пользователям. Параметр игнорируется для объекта "members.third"
phoneID	Нет*	array of integers	Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве - 3 *Если пользователь не авторизован, то параметр игнорируется.Если пользователь авторизован, то передача одного из взаимоисключающих параметров "phoneID" или "phoneNumbers" является обязательной
phoneNumbers	Нет*	array of phoneNumbers	Список телефонных номеров. Для авторизованных пользователей максимальное количество элементов в массиве - 3, для неавторизванных - 1 *Параметр является обязательным для неавторизованных пользователей. Для авторизованных пользователей обязательна передача одного из взаимоисключающих параметров "phoneID" or "phoneNumbers"
phoneNumbers.number	Да	string	Номер телефона. Допускаются цифры и знак "+" в начале строк, начинающихся с 7 или 375
phoneNumbers.save	Нет	boolean	Флаг, обозначающий, что номер телефона необходимо сохранить в адресную книгу (см. методы адресной книги для работы с контактными данными) Сохранение в адресную книгу доступно только авторизованным пользователям. Параметр игнорируется для объекта "members.third"

Document

Document
Параметр	Обязательный	Тип	Описание
type	Да	string	Тип документа. Доступные значения: "passport" - паспорт; "drivingLicence" - водительское удостоверение; "foreignPassport" - заграничный паспорт. Для некоторых стран значение "foreignPassport" недоступно
serial	Да*	string	Серия документа *Для некоторых стран параметр не является обязательным и игнорируется
number	Да	string	Номер документа. Формат номера зависит от страны

Address

Address
Параметр	Обязательный	Тип	Описание
search	Нет (1)	string	Адрес в виде произвольной строки. Адрес может быть передан в виде текста или координат. Однако, координаты не следует использовать для передачи информации о юридическом адресе, то есть в блоках "juridicalAddress" класса "Counteragent". При передаче адреса в виде текста, помимо собственно адреса, в запрос следует включать наименование населённого пункта, элементы необходимо указывать через запятую, например, "Омск, Ленина, 5". Координаты также указываются через запятую, первое число - широта, например, "59.924501, 30.241762". Максимум - 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 символов
save	Нет	boolean	Флаг, обозначающий, что адрес необходимо сохранить в адресную книгу (см. методы адресной книги для работы с адресами) Сохранение в адресную книгу доступно только авторизованным пользователям. Параметр игнорируется для объекта "counteragent.juridicalAddress" (обновление юридического адреса происходит при передаче параметра "counteragent.save" со значением "true")
Примечания: Обязательно должен быть передан адрес - в виде произвольное строки ("search") или набора параметров (в этом случае обязательными являются параметры "street" и "house"). Передача параметра "search" исключает передачу параметров "street", "house", "building" и "structure", но допускает передачу параметра "flat" (в этом случае в качестве номера квартиры/офиса будет использоваться значение параметра "flat")

Ответ метода

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

JSON
XML

{
   "metadata":{
      "status":201,
      "generated_at":"2020-06-17 15:15:58"
   },
   "data":{
      "orderNumber":"ДЛТ000001322783",
      "addressBook":{
         "sender":{
            "counteragent":{
               "id":2009,
               "state":"existing"
            },
            "address":{
               "id":3074,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15016,
                  "state":"existing",
                  "value":"79136444444"
               }
            ],
            "contactPersons":[
               {
                  "id":14978,
                  "state":"existing",
                  "value":"Иванов Иван"
               }
            ]
         },
         "transit":{
            "counteragent":{
               "id":2020,
               "state":"existing"
            },
            "address":{
               "id":3090,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15918,
                  "state":"existing",
                  "value":"+79135333333"
               }
            ],
            "contactPersons":[
               {
                  "id":14990,
                  "state":"existing",
                  "value":"Соколова В. В."
               }
            ]
         },
         "receiver":{
            "counteragent":{
               "id":2010,
               "state":"existing"
            },
            "address":{
               "id":3075,
               "state":"existing"
            },
            "phoneNumbers":[
               {
                  "id":15018,
                  "state":"existing",
                  "value":"+79136333333"
               }
            ],
            "contactPersons":[
               {
                  "id":14979,
                  "state":"existing",
                  "value":"Петрова Н. В."
               }
            ]
         },
         "third":{
            "counteragent":{
               "id":2011,
               "state":"existing"
            }
         }
      },
      "foundAddresses": [
         {
            "field": "delivery.derival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.arrival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "delivery.transit.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.sender.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.transit.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.receiver.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         },
         {
            "field": "members.third.counteragent.juridicalAddress",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         }
      ]
   } 
}

<response> 
   <metadata>
      <status>201</status>
      <generated_at>2020-06-17 15:15:58</generated_at>
   </metadata>
   <data>
      <orderNumber>ДЛТ000001322783</orderNumber>
      <addressBook>
         <sender>
            <counteragent>
               <id>2009</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3074</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15016</id>
               <state>existing</state>
               <value>79136444444</value>
            </phoneNumbers>
            <contactPersons>
               <id>14978</id>
               <state>existing</state>
               <value>Иванов Иван</value>
            </contactPersons>
         </sender>
         <transit>
            <counteragent>
               <id>2020</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3090</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15918</id>
               <state>existing</state>
               <value>+79135333333</value>
            </phoneNumbers>
            <contactPersons>
               <id>14990</id>
               <state>existing</state>
               <value>Соколова В. В.</value>
            </contactPersons>
         </transit>
         <receiver>
            <counteragent>
               <id>2010</id>
               <state>existing</state>
            </counteragent>
            <address>
               <id>3075</id>
               <state>existing</state>
            </address>
            <phoneNumbers>
               <id>15018</id>
               <state>existing</state>
               <value>+79136333333</value>
            </phoneNumbers>
            <contactPersons>
               <id>14979</id>
               <state>existing</state>
               <value>Петрова Н. В.</value>
            </contactPersons>
         </receiver>
         <third>
            <counteragent>
               <id>2011</id>
               <state>existing</state>
            </counteragent>
         </third>
      </addressBook>
      <foundAddresses>
         <field>delivery.derival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.arrival.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>delivery.transit.address</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.sender.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.transit.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.receiver.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
      <foundAddresses>
         <field>members.third.counteragent.juridicalAddress</field>
         <source>Омск, Ленина, 5</source>
         <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result>
      </foundAddresses>
   </data>
</response>

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

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "201" (Created)
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	Data	Информация по итогу формирования заявки

Data

Data
Параметр	Тип	Описание
orderNumber	string	Номер заказа
addressBook	object	Данные о новых/отредактированных объектах адресной книги
addressBook.sender	Member	Данные отправителя
addressBook.transit	Member	Данные контрагента в промежуточной пункте маршрута
addressBook.receiver	Member	Данные получателя
addressBook.third	Member	Данные третьего лица
foundAddresses	array of FoundAddresses	Данные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address"

Member

Member
Параметр	Тип	Описание
counteragent	BookItem	Данные контрагента (см. методы адресной книги для работы с контрагентами)
address	BookItem	Данные адреса (см. методы адресной книги для работы с адресами) (1)
phoneNumbers	array of BookItem	Данные номера телефона (см. методы адресной книги для работы с контактными данными) (1)
contactPersons	array of BookItem	Данные контактного лица (см. методы адресной книги для работы с контактными данными) (1)
Примечания: Отсутствует у объекта "addressBook.third"

BookItem

BookItem
Параметр	Тип	Описание
id	integer	ID нового/отредактированного объекта адресной книги
state	string	Статус объекта. Возможные значения: "existing" - отредактированы данные существующего объекта; "new" - создан новый объект
value	string	Номер телефона (в случае объекта "phoneNumbers")/имя контактного лица (в случае объекта "contactPersons") Отсутствует у объектов "counteragent" и "address"

FoundAddresses

FoundAddresses
Параметр	Тип	Описание
field	string	Объект, в котором был передан параметр "search"
source	string	Введённое значение
result	string	Найденный адрес

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

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

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

Междугородняя перевозка еврофурой

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

Междугородняя перевозка еврофурой

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

Структура запроса

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

Request

Waypoint

Requester

Member

Document

Address

Ответ метода

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

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

Response

Data

Member

BookItem

FoundAddresses

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