Мультизаявка
Общие сведения
Настоящий сервис позволяет объединять заказы на доставку с одинаковым адресом отправки в одну мультизаявку для мультиотправки.
Настоящий сервис предназначен для объединения заказов на доставку от адреса отправителя, для объединения заказов на доставку от терминала в пакетный заказ следует воспользоваться методом "Пакетный заказ Pre-Alert"
Мультизаявка
Запрос метода
Структура запроса
Адрес метода: https://api.dellin.ru/v1/customers/multi_request.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sessionID":"00000000-0000-0000-0000-000000000000", "requestids":["1111","2222","3333"], "comment":"Текст комментария" }
Адрес метода: https://api.dellin.ru/v1/customers/multi_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 ранее созданных заказов, которые требуется объединить в мультизаявку Для оформления заказа следует использовать метод "Перевозка сборных грузов", при этом параметр запроса "inOrder" должен иметь значение "false". Это указывает на то, что заказы не будут поставлены в очередь на обработку в момент создания. После объединения заказов при помощи метода v1/customers/multi_request они автоматически будут поставлены в очередь |
comment | Нет | string | Комментарий |
Ответ метода
Структура ответа
{ "answer":{ "requestID":112, "state":"success" } }
<response> <answer> <requestid>112</requestid> <state>success</state> </answer> </response>
Описание параметров
Response
Response | ||
---|---|---|
Параметр | Тип | Описание |
answer | object | Информация по итогу формирования мультизаявки |
answer.requestID | integer | ID созданной мультизаявки |
answer.state | string | Статус выполнения |
Обработка ошибок
Если указан несуществующий номер заявки, или заявка создана с параметром "inOrder" = "true", то будет выведена следующая ошибка:
Пример ответа
{ "errors":{ "requestids":"Error: id заявок не соответствует условиям: 12345678" } }
<response> <errors> <requestids>Error: id заявок не соответствует условиям: 12345678</requestids> </errors> </response>
При попытке объединить заявки, созданные под разными учетными записями, сообщение об ошибке будет иметь следующий вид:
Пример ответа
{ "errors":{ "requestids":"ошибка c контрагентом отправителя" } }
<response> <errors> <requestids>ошибка c контрагентом отправителя</requestids> </errors> </response>
Если указаны разные адреса отправки, то будет выведена следующая ошибка:
Пример ответа
{ "errors":{ "requestids":"ошибка с адресом отправки" } }
<response> <errors> <requestids>ошибка с адресом отправки</requestids> </errors> </response>
Если передан только один номер заявки, то сообщение об ошибке будет следующим:
Пример ответа
{ "errors":{ "requestids":"Количество id необходимо более одного" } }
<response> <errors> <requestids>Количество id необходимо более одного</requestids> </errors> </response>