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

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

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

Обновлено 08.09.2017
82 кб

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

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

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

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

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

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

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

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"345235",
   "deviceID":"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>
   <deviceid>345235</deviceid>
</request>

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

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

sessionID

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

orderID

ДаstringID заказа, который необходимо добавить в избранное
deviceIDДаstringID устройства для отслеживания событий публичной части МП

Ответ метода

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

{  
   
}
<response>
   
</response>

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

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

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

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

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

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

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

itemData.terminalIdintegerID терминала. Необходимо для отображения ссылки на терминал под текстом из terminalInfo
itemData.terminalInfostringИнформация, связанная с терминалом, на котором находится груз
itemData.stateInfostringОбщая информация о выдаче, зависящая от статуса
itemData.warningstring

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

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

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

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

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

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

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

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

Адрес метода: 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>
   <deviceid>345235</deviceid>
   <suspendDate>0000-00-00</suspendDate>
</request>

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

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

sessionID

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

orderID

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

Ответ метода

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

{   
   "status":"success"
}
<response>
   <status>success</status>
</response>

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

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

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

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

  • "success"
  • "error"

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

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

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

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

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

Адрес метода: 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>
   <deviceid>345235</deviceid>
   <resumedate>0000-00-00</resumedate>
</request>

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

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

sessionID

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

orderID

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

Ответ метода

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

{   
   "status":"success"
}
<response>
   <status>success</status>
</response>

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

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

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

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

  • "success"
  • "error"