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

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

Приостановка и возобновление выдачи груза

Обновлено 26.03.2020
88 кб

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

Сервис позволяет приостановить или возобновить выдачу груза.

Запрос на приостановку

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

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

Адрес метода: https://api.dellin.ru/v3/orders/suspend.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"345235",
   "suspendDate":"2018-05-31"
}

Адрес метода: https://api.dellin.ru/v3/orders/suspend.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>345235</orderID>
   <suspendDate>2018-05-31</suspendDate>
</request>

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

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

orderID

ДаstringID заказа, который необходимо заблокировать
suspendDateДаstringДата, до которой будет приостановлена выдача груза

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "state":"success"
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>success</state>
   </data>
</response>

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

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

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

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

dataobjectПодтверждение успешности операции
data.statestring

Статус обработки запроса. Возможное значение - "success" (операция успешно завершена)

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

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

608001

400

Заказ не найден

608002

400

Операция недоступна

608003

400

Некорректная дата

Запрос на возобновление

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

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

Адрес метода: https://api.dellin.ru/v3/orders/resume.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"345235",
   "resumeDate":"2018-05-25"
}

Адрес метода: https://api.dellin.ru/v3/orders/resume.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>345235</orderID>
   <resumeDate>2018-05-25</resumeDate>
</request>

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

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

orderID

ДаstringID заказа, который необходимо разблокировать
resumeDateДаstringДата, с которой должна стать доступной выдача груза

Ответ метода

Ответ метода "Запрос на возобновление" аналогичен ответу метода "Запрос на приостановку".

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

Ошибки метода "Запрос на возобновление" аналогичны ошибкам метода "Запрос на приостановку".