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

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

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

Обновлено 23.07.2018
103 кб

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

Сервис позволяет проверить доступность приостановки и возобновления выдачи груза, а также приостановить или возобновить выдачу груза из мобильного приложения (МП).

Данная функция дублирует аналогичный механизм ЛК, но с ограничением: в МП включена только та часть, которая доступна пользователям с полным доступом к контрагенту-отправителю.

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

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

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

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

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"345235"
}

Адрес метода: https://api.dellin.ru/v1/customers/order/change_available.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <orderid>345235</orderid>
</request>

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

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

sessionID

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

orderID

ДаstringID заказа, который необходимо добавить в избранное

Ответ метода

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

{
   "services":[
      {
         "code":"suspend",
         "displayName":"Приостановка выдачи груза",
         "itemData":{
            "terminalInfo":"Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б",
            "availableTill":"2018-06-10",
            "warning":"Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.",
            "terminalId":53,
            "stateInfo":"Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу."
         }
      }
   ]
}
<response>
   <services>
      <code>suspend</code>
      <displayName>Приостановка выдачи груза</displayName>
      <itemData>
         <terminalInfo>Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б</terminalInfo>
         <availableTill>2018-06-10</availableTill>
         <warning>Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.</warning>
         <terminalId>53</terminalId>
         <stateInfo>Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу.</stateInfo>
      </itemData>
   </services>
</response>

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

Response
ПараметрТипОписание
servicesarray of Response.Services

Перечень доступных услуг

Response.Services
ПараметрТипОписание
codestring

Кодовое обозначение услуги.

Возможные значения:

  • "suspend" - приостановка выдачи груза
  • "resume" - возобновление выдачи груза
displayNamestringОтображаемое в МП наименование услуги
itemDataobjectСписок атрибутов услуги
itemData.terminalInfostringИнформация, связанная с терминалом, на котором находится груз
itemData.availableTillstring

Дата, до которой возможна приостановка/возобновление выдачи груза (включительно).

Формат: ГГГГ-ММ-ДД

itemData.warningstring

Текст предупреждения при выборе наименьшей доступной даты.

Значение по умолчанию:

  • при значении параметра "code" = suspend: "Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи."
  • при значении параметра "code" = resume: "Снятие ограничения в день запроса не гарантировано при подаче запроса вечером. Информация о том, что ограничение на выдачу груза снято, появится в карточке заказа."
itemData.terminalIdintegerID терминала. Необходимо для отображения ссылки на терминал под текстом из terminalInfo
itemData.stateInfostringОбщая информация о выдаче, зависящая от статуса

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

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

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

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

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

Адрес метода: https://api.dellin.ru/v1/customers/order/suspend.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <orderid>345235</orderid>
   <suspendDate>2018-05-31</suspendDate>
</request>

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

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

sessionID

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

orderID

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

Ответ метода

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

{  
   "status":"error",
   "errors":{  
      "orderID":"Операция недоступна",
      "suspendDate":"Требуется"
   }
}
<response>
   <status>error</status>
   <errors>
      <orderid>Операция недоступна</orderid>
      <suspenddate>Требуется</suspenddate>
   </errors>
</response>

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

Response
ПараметрТипОписание
statusstring

Статус обработки запроса.

Возможные значения:

  • "success"
  • "error"
errorsResponse.Errors

Перечень неверно переданных параметров с описанием ошибок.

Объект выводится, только если значение параметра "status" равно "error"

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

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

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

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

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

Адрес метода: https://api.dellin.ru/v1/customers/order/resume.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <orderid>345235</orderid>
   <resumedate>2018-05-25</resumedate>
</request>

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

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

sessionID

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

orderID

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