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

API
Главная / API - Создание мультизаявки

Создание мультизаявки

Обновлено 09.08.2017
66 кб

Общая информация

С помощью этого метода можно объединять несколько заявок в одну мультизаявку для мультиотрпавки.

Создание мультизаявки

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

Пример запроса

Адрес метода: https://api.dellin.ru/v1/customers/multi_request.json

{  
   "appkey":"00000000-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-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <requestids>1111</requestids>
   <requestids>2222</requestids>
   <requestids>3333</requestids>
   <comment>Текст комментария</comment>
</request>

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

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
requestidsДаarray of strings

Перечень ID ранее созданных заявок, которые требуется объединить в мультизаявку

commentНетstringКомментарий
Обратите внимание, что объединять в мультизаявку можно только заявки с одинаковым адресом забора груза. В противном случае ответ метода будет содержать сообщение об ошибке.При создании заявок, которые предполагается объединить в мультизаявку, в запросах необходимо указывать параметр "inOrder" = 0. Это указывает на то, что заявки не будут поставлены в очередь на обработку в момент создания. После объединения заявок методом "multi_request" они автоматически будут поставлены в очередь.

Ответ метода

Пример ответа

{  
   "answer":{  
      "requestID":112,
      "state":"success"
   }
}
<response>
   <answer>
      <requestid>112</requestid>
      <state>success</state>
   </answer>
</response>

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

Response
ПараметрТипОписание
requestIDintegerID созданной мультизаявки
statestringСтатус выполнения

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

Если указан несуществующий номер заявки, или заявка создана с параметром "inOrder" = 1, то будет выведена следующая ошибка:

Пример ответа

{  
   "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>