Пакетный заказ Пре-алерт
Общие сведения
Пакетный заказ - объединение нескольких существующих заказов на доставку от терминала с целью ускорения процедуры обработки груза на терминале.
Сервис позволяет сформировать/расформировать пакетный заказ, передать данные водителя, который будет сдавать груз, автомобиля, на котором он прибудет на терминал, а также данные по грузовым местам объединяемых заказов.
Для использования метода необходимо связаться с менеджером Компании и сообщить о желании использовать решение Pre-Alert.
Оформление пакетного заказа
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/batch_request.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "requestIDs":["1111","2222","3333"], "comment":"Текст комментария" }
Адрес метода: https://api.dellin.ru/v2/batch_request.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <requestIDs>1111</requestIDs> <requestIDs>2222</requestIDs> <requestIDs>3333</requestIDs> <comment>Текст комментария</comment> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
requestIDs | Да | array of strings | ID заказов, которые необходимо объединить в пакетный заказ (для оформления заказа следует использовать метод "Перевозка сборных грузов") Примечания:
|
comment | Нет | string | Комментарий. Максимум 300 символов |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2020-06-17 15:15:58" }, "data":{ "batchRequestID":12345, "state":"success" } }
<response> <metadata> <status>200</status> <generated_at>2020-06-17 15:15:58</generated_at> </metadata> <data> <batchRequestID>12345</batchRequestID> <state>success</state> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Информация по итогу формирования пакетного заказа |
data.batchRequestID | integer | ID созданного пакетного заказа |
data.state | string | Статус. Возможное значение - "success" (операция успешно завершена) |
Обработка ошибок
Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:
Номер ошибки | http-код | Краткое описание ошибки |
---|---|---|
616001 | 400 | Указанные заказы не соответствуют условиям группировки в мультизаявку |
Отмена пакетного заказа
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/batch_request/cancel.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "batchRequestID":12345 }
Адрес метода: https://api.dellin.ru/v2/batch_request/cancel.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <batchRequestID>12345</batchRequestID> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
batchRequestID | Да | integer | ID пакетного заказа, который необходимо расформировать Пакетный заказ должен быть создан текущим пользователем |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2020-06-17 15:15:58" }, "data":{ "state":"success" } }
<response> <metadata> <status>200</status> <generated_at>2020-06-17 15:15:58</generated_at> </metadata> <data> <state>success</state> </data> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success) |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | object | Информация о выполнении операции |
data.state | string | Статус. Возможное значение - "success" (операция успешно завершена) |
Обработка ошибок
Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:
Номер ошибки | http-код | Краткое описание ошибки |
---|---|---|
617001 | 400 | Невозможно отменить данную мультизаявку |
Передача данных водителя и машины
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/batch_request/update.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "batchRequestID":12345, "carNumber": "С690ТН55", "driverName": "Иванов Петр Викторович" }
Адрес метода: https://api.dellin.ru/v2/batch_request/update.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <batchRequestID>12345</batchRequestID> <carNumber>С690ТН55</carNumber> <driverName>Иванов Петр Викторович</driverName> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
batchRequestID | Да | integer | ID пакетного заказа Пакетный заказ должен быть создан текущим пользователем |
carNumber | Нет | string | Номер машины, на которой груз будет доставлен на терминал (1) |
driverName | Нет | string | ФИО водителя, который доставит груз на терминал (1) |
Примечания:
|
Ответ метода
Обработка ошибок
Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:
Номер ошибки | http-код | Краткое описание ошибки |
---|---|---|
618001 | 400 | Невозможно обновить данные по этой мультизаявке |
Передача данных по грузовым местам
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v2/request/cargo.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "requestID":"111111", "cargoPlaces":[ { "cargoPlace":"123123", "amount":1, "volume":1, "weight":2.3, "length":1, "width":1, "height":1 }, { "cargoPlace":"22222", "amount":1, "volume":1, "weight":2.3, "length":1, "width":1, "height":1 } ] }
Адрес метода: https://api.dellin.ru/v2/request/cargo.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sessionID>00000000-0000-0000-0000-000000000000</sessionID> <requestID>111111</requestID> <cargoPlaces> <cargoPlace>123123</cargoPlace> <amount>1</amount> <volume>1</volume> <weight>2.3</weight> <length>1</length> <width>1</width> <height>1</height> </cargoPlaces> <cargoPlaces> <cargoPlace>22222</cargoPlace> <amount>1</amount> <volume>1</volume> <weight>2.3</weight> <length>1</length> <width>1</width> <height>1</height> </cargoPlaces> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Параметр | Обязательный | Тип | Описание |
appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
sessionID | Да | string | ID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя" |
requestID | Да | string | ID заказа (для оформления заказа следует использовать метод "Перевозка сборных грузов") Заказ должен быть создан текущим пользователем. |
cargoPlaces | Да | array of CargoPlaces | Данные по грузовым местам |
cargoPlaces.cargoPlace | Да | string | Номер грузового места (грузовые места маркируются заказчиком) |
cargoPlaces.amount | Да | integer | Количество грузовых мест с одинаковой маркировкой |
cargoPlaces.volume | Нет | float | Объём грузового места, м3 (1) |
cargoPlaces.weight | Нет | float | Вес грузового места, кг (1) |
cargoPlaces.length | Нет | float | Длина грузового места, м (1) |
cargoPlaces.width | Нет | float | Ширина грузового места, м (1) |
cargoPlaces.height | Нет | float | Высота грузового места, м (1) |
Примечания:
|
Ответ метода
Обработка ошибок
Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:
Номер ошибки | http-код | Краткое описание ошибки |
---|---|---|
619001 | 400 | Невозможно внести данные по грузоместам в предзаказ |