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

API
Главная / API - Подбор даты доставки

Подбор даты доставки

Обновлено 20.01.2023
Скачать в PDF
125 кб
Содержание:

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

Сервис позволяет получить список возможных дат доставки при оформлении заявки на доставку от терминала до адреса получателя (см. метод "Дополнение заказа доставкой до адреса получателя"). Сервис доступен только авторизованным пользователям.

Даты доставки

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docID":"2000085063763",
   "delivery":{
      "arrival":{
         "addressID":3357,
         "address":{
            "search":"Омск, Ленина, 5",
            "street":"5500000100005970000000000",
            "house":"5",
            "building":"1",
            "structure":"4",
            "flat":"1"
         },
         "city":"5500000100000000000000000",
         "time":{
            "exactTime":true
         },
         "handling":{
            "freightLift":true,
            "toFloor":10,
            "carry":100
         },
         "requirements":[
            "0xabb9c63c596b08f94c3664c930e77778",
            "0x88f93a2c37f106d94ff9f7ada8efe886",
            "0x818e8ff1eda1abc349318a478659af08",
            "0xb83b7589658a3851440a853325d1bf69",
            "0x92fce2284f000b0241dad7c2e88b1655",
            "0x9951e0ff97188f6b4b1b153dfde3cfec"
         ]
      }
   }
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <docID>2000085063763</docID>
   <delivery>
      <arrival>
         <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>
         <time>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>100</carry>
         </handling>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
         <requirements>0x88f93a2c37f106d94ff9f7ada8efe886</requirements>
         <requirements>0x818e8ff1eda1abc349318a478659af08</requirements>
         <requirements>0xb83b7589658a3851440a853325d1bf69</requirements>
         <requirements>0x92fce2284f000b0241dad7c2e88b1655</requirements>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
      </arrival>
   </delivery>
</request>

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

Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
docIDДаstringНомер заказа, накладной или заявки на доставку до терминала, оформленной при помощи метода "Перевозка сборных грузов", на основании которой планируется дозаказать доставку до адреса (см. метод "Дополнение заказа доставкой до адреса получателя")
deliveryДаobjectИнформация о доставке
delivery.arrivalДаArrival

Информация о доставке до адреса получателя. Допускается передача пустого объекта

Arrival
Arrival
ПараметрОбязательныйТипОписание
addressIDНетinteger

ID адреса из "Адресной книги"

Позволяет получить возможные даты доставки до адреса, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city"
addressНетAddress

Адрес

Позволяет получить возможные даты доставки до адреса, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city"
cityНетstring

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

Позволяет получить возможные даты доставки до населённого пункта, отличного от указанного в накладной. Допускается передача только одного из следующих параметров: "addressID", "address" или "city"
timeНетobjectИнформация о времени доставки
time.exactTimeНетboolean

Флаг, обозначающий, что необходима доставка точно в указанное время.

Значение по умолчанию: "false"

handlingНетobjectИнформация о погрузо-разгрузочных работах
handling.freightLiftНетboolean

Флаг, обозначающий, что есть грузовой лифт.

Значение по умолчанию: "false"

handling.toFloorНетinteger

Номер этажа, на который необходимо поднять груз

handling.carryНетintegerРасстояние, на которое необходимо перенести груз (в метрах)
requirementsНетarray of strings

Массив UID видов погрузки/дополнительных требований к транспорту.

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

  • 0xb83b7589658a3851440a853325d1bf69 - боковая погрузка;
  • 0xabb9c63c596b08f94c3664c930e77778 - верхняя погрузка;
  • 0x92fce2284f000b0241dad7c2e88b1655 - гидроборт (грузоподъёмная платформа);
  • 0x88f93a2c37f106d94ff9f7ada8efe886 - манипулятор (подъёмное устройство);
  • 0x9951e0ff97188f6b4b1b153dfde3cfec - открытая машина;
  • 0x818e8ff1eda1abc349318a478659af08 - растентовка (снятие тента с автомобиля)

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 символов

Примечания:

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

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2020-06-03 09:06:54"
   },
   "data":{
      "dates":[
         "2020-06-04",
         "2020-06-05",
         "2020-06-06",
         "2020-06-07",
         "2020-06-08",
         "2020-06-09",
         "2020-06-10",
         "2020-06-11",
         "2020-06-12",
         "2020-06-13",
         "2020-06-14",
         "2020-06-15",
         "2020-06-16",
         "2020-06-17",
         "2020-06-18",
         "2020-06-19",
         "2020-06-20",
         "2020-06-21",
         "2020-06-22",
         "2020-06-23",
         "2020-06-24",
         "2020-06-25",
         "2020-06-26",
         "2020-06-27",
         "2020-06-28",
         "2020-06-29",
         "2020-06-30",
         "2020-07-01",
         "2020-07-02",
         "2020-07-03",
         "2020-07-04",
         "2020-07-05",
         "2020-07-06",
         "2020-07-07",
         "2020-07-08",
         "2020-07-09",
         "2020-07-10",
         "2020-07-11",
         "2020-07-12",
         "2020-07-13",
         "2020-07-14",
         "2020-07-15",
         "2020-07-16",
         "2020-07-17",
         "2020-07-18",
         "2020-07-19",
         "2020-07-20",
         "2020-07-21",
         "2020-07-22",
         "2020-07-23",
         "2020-07-24",
         "2020-07-25",
         "2020-07-26",
         "2020-07-27",
         "2020-07-28",
         "2020-07-29",
         "2020-07-30",
         "2020-07-31",
         "2020-08-01",
         "2020-08-02"
      ],
      "foundAddresses": [
         {
            "field": "delivery.derival.address",
            "source": "Омск, Ленина, 5",
            "result": "Россия, Омская обл, г Омск, ул Ленина, д 5"
         }
      ]
   }
}
<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <delivery>
      <deliveryType>
         <type>auto</type>
      </deliveryType>
      <derival>
         <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>
         <time>
            <exactTime>true</exactTime>
         </time>
         <handling>
            <freightLift>true</freightLift>
            <toFloor>10</toFloor>
            <carry>100</carry>
         </handling>
         <requirements>0xabb9c63c596b08f94c3664c930e77778</requirements>
         <requirements>0x88f93a2c37f106d94ff9f7ada8efe886</requirements>
         <requirements>0x818e8ff1eda1abc349318a478659af08</requirements>
         <requirements>0xb83b7589658a3851440a853325d1bf69</requirements>
         <requirements>0x92fce2284f000b0241dad7c2e88b1655</requirements>
         <requirements>0x9951e0ff97188f6b4b1b153dfde3cfec</requirements>
      </derival>
   </delivery>
   <cargo>
      <quantity>4</quantity>
      <weight>12</weight>
      <height>1</height>
      <width>1</width>
      <length>1</length>
      <totalVolume>1</totalVolume>
      <totalWeight>12</totalWeight>
   </cargo>
</request>

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

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

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

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

dataobjectИнформация о возможных датах доставки
data.datesarray of strings

Список возможных дат доставки.

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

data.foundAddressesarray of FoundAddressesДанные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address"

FoundAddresses
FoundAddresses
ПараметрТипОписание
fieldstringОбъект, в котором был передан параметр "search"
sourcestring

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

resultstring

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

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

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