Доступные изменения заказа
Общие сведения
Сервис позволяет проверить возможность:
- смены получателя;
- смены плательщика;
- изменения способа оплаты;
- изменения контактной информации по заказу;
- изменения адреса отправки и доставки груза;
- приостановки и возобновления выдачи;
- отмены заявки на доставку от адреса отправителя;
- отмены заявки на доставку до адреса получателя (для получения груза клиенту необходимо будет приехать на терминал компании "Деловые Линии").
Доступные изменения
Запрос метода
Структура запроса
Адрес метода: 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 | Да | string | ID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя" |
orderID | Да | integer | Номер заказа, по которому необходимо проверить возможность изменения данных |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":{ "receiver":{ "available":true, "displayName":"Изменение получателя по заказу" }, "payer":{ "available":false, "displayName":"Изменение плательщика по заказу", "info":"Недостаточно доступа к одному из: отправитель грузоперевозки / новый плательщик" }, "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>false</available> <displayName>Изменение плательщика по заказу</displayName> <info>Недостаточно доступа к одному из: отправитель грузоперевозки / новый плательщик</info> </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 | ||
---|---|---|
Параметр | Тип | Описание |
metadata | object | Системная информация |
metadata.status | integer | Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400" |
metadata.generated_at | string | Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС" |
data | Data | Информация о возможности изменения данных по заказу |
Data
Data | ||
---|---|---|
Параметр | Тип | Описание |
receiver | ChangeInfo | Информация о возможности изменения получателя заказа |
payer | ChangeInfo | Информация о возможности изменения плательщика по заказу |
contactInfo | object | Информация о возможности изменения контактной информации по заказу |
contactInfo.changeSender | ChangeInfo | Информация о возможности изменения контактных данных отправителя |
contactInfo.changeReceiver | ChangeInfo | Информация о возможности изменения контактных данных получателя |
pickupInfo | ChangeInfo | Информация о возможности изменения адреса отправки, а также времени передачи груза водителю-экспедитору на адресе отправки |
deliveryInfo | ChangeInfo | Информация о возможности изменения адреса доставки, а также времени получения груза на адресе доставки |
suspend | SuspendResume | Информация о возможности приостановки выдачи груза |
resume | SuspendResume | Информация о возможности возобновления выдачи груза |
cancelPickup | ChangeInfo | Информация о возможности отмены заявки на доставку от адреса отправителя |
cancelDelivery | ChangeInfo | Информация о возможности отмены заявки на доставку до адреса получателя (для получения груза клиенту необходимо будет приехать на терминал компании "Деловые Линии") |
ChangeInfo
ChangeInfo | ||
---|---|---|
Параметр | Тип | Описание |
available | boolean | Флаг, обозначающий возможность изменения информации. Возможные значения:
|
displayName | string | Изменяемая информация |
info | string | Дополнительная информация по возможности изменения плательщика Данный вложенный параметр есть только у объектa response.data.payer, параметр присутствует в ответе только в случае наличия дополнительной информации |
SuspendResume
SuspendResume | ||
---|---|---|
Параметр | Тип | Описание |
available | boolean | Флаг, обозначающий возможность изменения информации. Возможные значения:
|
displayName | string | Изменяемая информация |
info | object | Дополнительная информация по возможности изменения |
info.terminalInfo | string | Информация о терминале, на который прибудет груз |
info.availableTill | string | Дата до которой (включительно) возможна приостановка/возобновление выдачи груза |
info.warning | string | Дополнительная информация, актуальная в случае, если дата, полученная в параметре "info.availableTill", будет передана в запросе метода на приостановку/возобновление выдачи в качестве значения параметра "suspendDate"/"resumeDate" |
info.terminalId | integer | ID терминала, на который прибудет груз |
info.stateInfo | string | Дополнительная информация |
Обработка ошибок
В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".