Подбор даты доставки
Общие сведения
Сервис позволяет получить список возможных дат доставки при оформлении заявки на доставку от терминала до адреса получателя (см. метод "Дополнение заказа доставкой до адреса получателя"). Сервис доступен только авторизованным пользователям.
Даты доставки
Запрос метода
Структура запроса
Адрес метода: 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 | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
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 видов погрузки/дополнительных требований к транспорту. Возможные значения:
|
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":{ "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" ], "priorityDirectionForDelivery":true, "foundAddresses":[ { "field": "delivery.derival.address", "source": "Омск, Ленина, 5", "result": "Россия, Омская обл, г Омск, ул Ленина, д 5" } ] } }
<request> <metadata> <status>200</status> <generated_at>2020-06-03 09:06:54</generated_at> </metadata> <data> <dates>2020-06-04</dates> <dates>2020-06-05</dates> <dates>2020-06-06</dates> <dates>2020-06-07</dates> <dates>2020-06-08</dates> <dates>2020-06-09</dates> <dates>2020-06-10</dates> <dates>2020-06-11</dates> <dates>2020-06-12</dates> <dates>2020-06-13</dates> <dates>2020-06-14</dates> <dates>2020-06-15</dates> <dates>2020-06-16</dates> <dates>2020-06-17</dates> <dates>2020-06-18</dates> <dates>2020-06-19</dates> <dates>2020-06-20</dates> <dates>2020-06-21</dates> <dates>2020-06-22</dates> <dates>2020-06-23</dates> <dates>2020-06-24</dates> <dates>2020-06-25</dates> <dates>2020-06-26</dates> <dates>2020-06-27</dates> <dates>2020-06-28</dates> <dates>2020-06-29</dates> <dates>2020-06-30</dates> <dates>2020-07-01</dates> <dates>2020-07-02</dates> <dates>2020-07-03</dates> <dates>2020-07-04</dates> <dates>2020-07-05</dates> <dates>2020-07-06</dates> <dates>2020-07-07</dates> <dates>2020-07-08</dates> <dates>2020-07-09</dates> <dates>2020-07-10</dates> <dates>2020-07-11</dates> <dates>2020-07-12</dates> <dates>2020-07-13</dates> <dates>2020-07-14</dates> <dates>2020-07-15</dates> <dates>2020-07-16</dates> <dates>2020-07-17</dates> <dates>2020-07-18</dates> <dates>2020-07-19</dates> <dates>2020-07-20</dates> <dates>2020-07-21</dates> <dates>2020-07-22</dates> <dates>2020-07-23</dates> <dates>2020-07-24</dates> <dates>2020-07-25</dates> <dates>2020-07-26</dates> <dates>2020-07-27</dates> <dates>2020-07-28</dates> <dates>2020-07-29</dates> <dates>2020-07-30</dates> <dates>2020-07-31</dates> <dates>2020-08-01</dates> <dates>2020-08-02</dates> <priorityDirectionForDelivery>true</priorityDirectionForDelivery> <foundAddresses> <field>delivery.derival.address</field> <source>Омск, Ленина, 5</source> <result>Россия, Омская обл, г Омск, ул Ленина, д 5</result> </foundAddresses> </data> </request>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | ТипТип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Информация о возможных датах доставки |
data.dates | array of strings | Список возможных дат доставки. Формат: "ГГГГ-ММ-ДД" |
data.priorityDirectionForDelivery | boolean | Признак приоритетного направления доставки |
data.foundAddresses | array of FoundAddresses | Данные по найденным адресам. Параметр присутствует в ответе, только если в запросе был передан параметр "search" класса "Address" |
FoundAddresses
FoundAddresses | ||
---|---|---|
Параметр | Тип | Описание |
field | string | Объект, в котором был передан параметр "search" |
source | string | Введённое значение |
result | string | Найденный адрес |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".