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

API
Главная / API - Проверка изменения заказа

Проверка возможности изменения заказа

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

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

Сервис позволяет проверить возможность:

  • смены получателя;
  • смены плательщика;
  • изменения способа оплаты;
  • изменения контактной информации по заказу;
  • изменения адреса отправки и доставки груза;
  • приостановки и возобновления выдачи;
  • отмены заявки на доставку от адреса отправителя;
  • отмены заявки на доставку до адреса получателя (для получения груза клиенту необходимо будет приехать на терминал компании "Деловые Линии").

Проверка возможности изменения заказа

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

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

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

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

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

<request>
	<appkey>00000000-0000-0000-0000-000000000000</appkey>
	<sessionID>00000000-0000-0000-0000-000000000000</sessionID>
	<orderID>00000000</orderID>
</request>

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

Request
Request
ПараметрОбязательныйТипОписание

appkey

ДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
sessionIDДаstringID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя"

orderID

ДаintegerНомер заказа, по которому необходимо проверить возможность изменения данных

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "receiver":{
         "available":true,
         "displayName":"Изменение получателя по заказу"
      },
      "payer":{
         "available":true,
         "displayName":"Изменение плательщика по заказу"
      },
      "contactInfo":{
         "changeSender":{
            "available":true,
            "displayName":"Изменение контактной информации об отправителе"
         },
         "changeReceiver":{
            "available":true,
            "displayName":"Изменение контактной информации о получателе"
         }
      },
      "pickupInfo":{
         "available":true,
         "displayName":"Изменение информации об адресе и времени забора"
      },
      "deliveryInfo":{
         "available":true,
         "displayName":"Изменение информации об адресе и времени доставки"
      },
      "suspend":{
         "available":true,
         "displayName":"Приостановка выдачи груза",
         "info":{
            "terminalInfo":"Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б",
            "availableTill":"2018-06-10",
            "warning":"Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.",
            "terminalId":53,
            "stateInfo":"Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу."
         }
      },
      "resume":{
         "available":false,
         "displayName":"Возобновление выдачи груза",
         "info":{
            "terminalInfo":"Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б",
            "availableTill":"2018-06-10",
            "warning":"Снятие ограничения в день запроса не гарантировано при подаче запроса вечером. Информация о том, что ограничение на выдачу груза снято, появится в карточке заказа",
            "terminalId":53,
            "stateInfo":"Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу."
         }
      },
      "cancelPickup":{
         "available":true,
         "displayName":"Отмена забора груза от адреса"
      },
      "cancelDelivery":{
         "available":true,
         "displayName":"Отмена доставки груза до адреса"
      }
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <receiver>
         <available>true</available>
         <displayName>Изменение получателя по заказу</displayName>
      </receiver>
      <payer>
         <available>true</available>
         <displayName>Изменение плательщика по заказу</displayName>
      </payer>
      <contactInfo>
         <changeSender>
            <available>true</available>
            <displayName>Изменение контактной информации об отправителе</displayName>
         </changeSender>
         <changeReceiver>
            <available>true</available>
            <displayName>Изменение контактной информации о получателе</displayName>
         </changeReceiver>
      </contactInfo>
      <pickupInfo>
         <available>true</available>
         <displayName>Изменение информации об адресе и времени забора</displayName>
      </pickupInfo>
      <deliveryInfo>
         <available>true</available>
         <displayName>Изменение информации об адресе и времени доставки</displayName>
      </deliveryInfo>
      <suspend>
         <available>true</available>
         <displayName>Приостановка выдачи груза</displayName>
         <info>
            <terminalInfo>Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б</terminalInfo>
            <availableTill>2018-06-10</availableTill>
            <warning>Выполнение запроса не гарантировано при подаче запроса после 17:00 текущего дня по местному времени терминала выдачи.</warning>
            <terminalId>53</terminalId>
            <stateInfo>Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу.</stateInfo>
         </info>
      </suspend>
      <resume>
         <available>false</available>
         <displayName>Возобновление выдачи груза</displayName>
         <info>
            <terminalInfo>Груз по вашему заказу прибудет на терминал по адресу г. Омск, 10 лет Октября ул., 180 Б лит. Б</terminalInfo>
            <availableTill>2018-06-10</availableTill>
            <warning>Снятие ограничения в день запроса не гарантировано при подаче запроса вечером. Информация о том, что ограничение на выдачу груза снято, появится в карточке заказа</warning>
            <terminalId>53</terminalId>
            <stateInfo>Приостановка выдачи груза получателю может потребовать оплаты хранения. Груз не будет выдан получателю до указанной вами даты либо до отмены запрета на выдачу.</stateInfo>
         </info>
      </resume>
      <cancelPickup>
         <available>true</available>
         <displayName>Отмена забора груза от адреса</displayName>
      </cancelPickup>
      <cancelDelivery>
         <available>true</available>
         <displayName>Отмена доставки груза до адреса</displayName>
      </cancelDelivery>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400"

metadata.generated_atstring

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

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

dataDataИнформация о возможности изменения данных по заказу

Data

Data

ПараметрТипОписание
receiverChangeInfoИнформация о возможности изменения получателя заказа
payerChangeInfo

Информация о возможности изменения плательщика по заказу

contactInfoobject

Информация о возможности изменения контактной информации по заказу

contactInfo.changeSenderChangeInfoИнформация о возможности изменения контактных данных отправителя
contactInfo.changeReceiverChangeInfoИнформация о возможности изменения контактных данных получателя
pickupInfoChangeInfoИнформация о возможности изменения адреса отправки, а также времени передачи груза водителю-экспедитору на адресе отправки
deliveryInfoChangeInfoИнформация о возможности изменения адреса доставки, а также времени получения груза на адресе доставки

suspend

ChangeInfoИнформация о возможности приостановки выдачи груза

resume

ChangeInfoИнформация о возможности возобновления выдачи груза
cancelPickupChangeInfoИнформация о возможности отмены заявки на доставку от адреса отправителя
cancelDeliveryChangeInfo

Информация о возможности отмены заявки на доставку до адреса получателя (для получения груза клиенту необходимо будет приехать на терминал компании "Деловые Линии")

ChangeInfo
ChangeInfo
ПараметрТипОписание
availableboolean

Флаг, обозначающий возможность изменения информации.

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

  • "true" - данные можно изменить;
  • "false" - внесение изменений недоступно
displayNamestring

Изменяемая информация

infoobject

Дополнительная информация по возможности изменения

Данный вложенный параметр есть только у объектов response.data.suspend и response.data.resume
info.terminalInfostringИнформация о терминале, на который прибудет груз

info.availableTill

stringДата до которой (включительно) возможна приостановка/возобновление выдачи груза
info.warningstringДополнительная информация, актуальная в случае, если дата, полученная в параметре "info.availableTill", будет передана в запросе метода на приостановку/возобновление выдачи в качестве значения параметра "suspendDate"/"resumeDate"
info.terminalIdintegerID терминала, на который прибудет груз
info.stateInfostring

Дополнительная информация

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".