Подбор времени приезда водителя
Общие сведения
Сервис позволяет получить информацию о доступных интервалах приезда водителя-экспедитора при передаче груза на адресе отправителя и доставке груза до адреса получателя. Проверка интервалов передачи груза при отправке доступна неавторизованным пользователям, в то время как для проверки интервалов доставки необходима авторизация.
Интервалы передачи груза на адресе отправителя
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request/address/time_interval.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "delivery":{ "deliveryType":{ "type":"auto" }, "derival":{ "produceDate":"2020-06-03", "addressID":3357, "address":{ "search":"Омск, Ленина, 5", "street":"5500000100005970000000000", "house":"5", "building":"1", "structure":"4", "flat":"1" }, "city":"5500000100000000000000000" } } }
Адрес метода: https://api.dellin.ru/v2/request/address/dates.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <delivery> <deliveryType> <type>auto</type> </deliveryType> <derival> <produceDate>2020-06-03</produceDate> <addressID>3357</addressID> <address> <search>Омск, Ленина, 5</search> <street>5500000100005970000000000</street> <house>5</house> <building>1</building> <structure>4</structure> <flat>1</flat> </address> <city>5500000100000000000000000</city> </derival> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Нет | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
delivery | Да | object | Информация о доставке |
delivery.deliveryType | Да | DeliveryType | Информация о виде межтерминальной перевозки груза |
delivery.derival | Да | Derival | Информация о доставке от адреса отправителя |
DeliveryType
DeliveryType | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
type | Да | string | Вид межтерминальной перевозки. Возможные значения:
Малогабаритный груз - это груз, параметры которого не превышают следующие значения:
|
Derival
Derival | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
produceDate | Да | string | Дата передачи груза водителю-экспедитору на адресе отправителя Формат: "ГГГГ-ММ-ДД" |
addressID | Нет* | integer | ID адреса из "Адресной книги" *В запросе обязательно должен присутствовать один из взаимоисключающих параметров: "addressID", "address" или "city" |
address | Нет* | Address | Адрес *В запросе обязательно должен присутствовать один из взаимоисключающих параметров: "addressID", "address" или "city" |
city | Нет* | string | Код КЛАДР населенного пункта. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР" *В запросе обязательно должен присутствовать один из взаимоисключающих параметров: "addressID", "address" или "city" |
Address
Address | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
search | Нет (1) | string | Адрес в виде произвольной строки. Адрес может быть передан в виде текста или координат. При передаче адреса в виде текста, помимо собственно адреса, в запрос следует включать наименование населённого пункта, элементы необходимо указывать через запятую, например, "Омск, Ленина, 5". Координаты также указываются через запятую, первое число - широта, например, "59.924501, 30.241762". Минимум 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 символов |
Примечания:
|
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2020-06-03 09:06:54" }, "data":{ "interval_from":"00:00:00", "interval_to":"23:59:00", "default_min_same_day_period":6, "min_same_day_period":2, "min_period":0, "same_day":false, "foundAddresses": [ { "field": "delivery.derival.address", "source": "Омск, Ленина, 5", "result": "Россия, Омская обл, г Омск, ул Ленина, д 5" } ] } }
<response> <metadata> <status>200</status> <generated_at>2020-06-30 06:33:53</generated_at> </metadata> <data> <interval_from>00:00:00</interval_from> <interval_to>23:59:00</interval_to> <default_min_same_day_period>6</default_min_same_day_period> <min_same_day_period>2</min_same_day_period> <min_period>0</min_period> <same_day>false</same_day> <foundAddresses> <field>delivery.derival.address</field> <source>Омск, Ленина, 5</source> <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result> </foundAddresses> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Данные интервала передачи груза на адресе отправителя/получателя (у клиента есть возможность указать, с какого по какое время должен приехать водитель-экспедитор, данный объект содержит информацию по допустимым параметрам интервала) |
data.interval_from | string | Допустимое начало интервала Формат: "ЧЧ:ММ:СС" |
data.interval_to | string | Допустимый конец интервала Формат: "ЧЧ:ММ:СС" |
data.default_min_same_day_period | integer | Стандартная продолжительность интервала в случае приезда экспедитора в день оформления заказа, ч |
data.min_same_day_period | integer | Минимальная продолжительность интервала в случае приезда экспедитора в день оформления заказа, ч |
data.min_period | integer | Минимальная продолжительность интервала, ч |
data.same_day | boolean | Флаг, обозначающий, что можно назначить приезд экспедитора на день оформления заказа |
data.foundAddresses | array of FoundAddresses | Данные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address" |
FoundAddresses
FoundAddresses | ||
---|---|---|
Параметр | Тип | Описание |
field | string | Объект, в котором был передан параметр "search" |
source | string | Введённое значение |
result | string | Найденный адрес |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".
Интервалы передачи груза на адресе получателя
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request_delivery/address/time_interval.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "docID":"2000085063763", "delivery":{ "arrival":{ "produceDate":"2020-06-03", "addressID":3357, "address":{ "search":"Омск, Ленина, 5", "street":"5500000100005970000000000", "house":"5", "building":"1", "structure":"4", "flat":"1" }, "city":"5500000100000000000000000" } } }
Адрес метода: https://api.dellin.ru/v2/request_delivery/address/time_interval.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <docID>2000085063763</docID> <delivery> <arrival> <produceDate>2020-06-03</produceDate> <addressID>3357</addressID> <address> <search>Омск, Ленина, 5</search> <street>5500000100005970000000000</street> <house>5</house> <building>1</building> <structure>4</structure> <flat>1</flat> </address> <city>5500000100000000000000000</city> </arrival> </delivery> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
docID | Да | string | Номер заказа, накладной или заявки, по которой необходимо получить информацию о возможных интервалах доставки до адреса получателя |
delivery | Да | object | Информация о доставке |
delivery.arrival | Да | Arrival | Информация о доставке до адреса получателя |
Arrival
Arrival | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
produceDate | Да | string | Дата доставки груза до адреса получателя Формат: "ГГГГ-ММ-ДД" |
addressID | Нет | integer | ID адреса из "Адресной книги" Позволяет получить информацию о возможных интервалах доставки до адреса, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city" |
address | Нет | Address | Адрес Позволяет получить информацию о возможных интервалах доставки до адреса, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city" |
city | Нет | string | Код КЛАДР населенного пункта. Может быть получен с помощью сервисов, представленных на странице "Поиск КЛАДР" Позволяет получить информацию о возможных интервалах доставки до населённого пункта, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city" |
Address
Address | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
search | Нет (1) | string | Адрес в виде произвольной строки. Адрес может быть передан в виде текста или координат. При передаче адреса в виде текста, помимо собственно адреса, в запрос следует включать наименование населённого пункта, элементы необходимо указывать через запятую, например, "Омск, Ленина, 5". Координаты также указываются через запятую, первое число - широта, например, "59.924501, 30.241762". Минимум 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 символов |
Примечания:
|
Ответ метода
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".