Отмена заказа и доставки груза до адреса получателя

Обновлено 24.08.2022

156 кб

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

Сервис позволяет отменить доставку от адреса отправителя/до адреса получателя. В случае отмены доставки от адреса пользователю необходимо оформить новый заказ на доставку от терминала (см. метод "Перевозка сборных грузов"), в случае отмены доставки до адреса для получения груза клиенту необходимо будет приехать на терминал компании "Деловые Линии"). Отмена доставки от/до адреса невозможна после 17:00 (по местному времени) дня, предшествующего дню заказа.

Для проверки возможности отмены доставки от/до адреса следует использовать метод "Доступные изменения заказа".

Изменения вступают в силу не сразу. После дополнительной проверки заявка на внесение изменений может быть одобрена или отклонена. Проверить статус заявки можно при помощи метода "История изменений заказа".

Отмена доставки от адреса отправителя

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"00000000",
   "contactIDs":[
      12345678,
      78456123
   ],
   "contactPersons":[
      {
         "name":"Иван Иванович"
      },
      {
         "name":"Петр Петрович"
      }
   ],
   "phoneIDs":[
      98765412,
      65478921
   ],
   "phoneNumbers":[
      {
         "number":"79213332211",
         "ext":"0123"
      }
   ]
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>00000000</orderID>
   <contactIDs>12345678</contactIDs>
   <contactIDs>78456123</contactIDs>
   <contactPersons>
      <name>Иван Иванович</name>
   </contactPersons>
   <contactPersons>
      <name>Петр Петрович</name>
   </contactPersons>
   <phoneIDs>98765412</phoneIDs>
   <phoneIDs>65478921</phoneIDs>
   <phoneNumbers>
      <number>79213332211</number>
      <ext>0123</ext>
   </phoneNumbers>
</request>

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

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя"
orderID	Да	string	Номер заказа, по которому необходимо отменить доставку от адреса
contactIDs	Нет*	array of integers	Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "contactIDs" или "contactPersons"
contactPersons	Нет*	array of contactPersons	Данные контактных лиц. Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "contactIDs" или "contactPersons"
contactPersons.name	Да	string	Имя контактного лица
phoneIDs	Нет*	array of integers	Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров: "phoneIDs" или "phoneNumbers"
phoneNumbers	Нет*	array of phoneNumbers	Список телефонных номеров. Максимальное количество элементов в массиве - 3 *В запросе обязательно должен быть передан один из взаимоисключающих параметров:: "phoneIDs" или "phoneNumbers"
phoneNumbers.number	Да	string	Номер телефона. Максимум 15 знаков (допускаются цифры и знак "+" в начале строки)
phoneNumbers.ext	Нет	string	Добавочный номер. Максимум 5 цифр

Ответ метода

Структура ответа

JSON
XML

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-18 12:52:26"
   },
   "data":{
      "status":"success",
      "info": "Запрос принят. По результату его обработки, заказу будет присвоен статус Отклонен."
   }
}

<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-18 12:52:26</generated_at>
   </metadata>
   <data>
      <status>success</status>
      <info>Запрос принят. По результату его обработки, заказу будет присвоен статус Отклонен.</info>
   </data>
</response>

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

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400"
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	object	Подтверждение успешности операции
data.status	string	Статус операции на английском языке. Возможное значение - "success" Статус "success" означает, что заявка на внесение изменений была принята. После дополнительной проверки заявка может быть одобрена или отклонена. Проверить статус заявки можно при помощи метода "История изменений заказа"
data.info	string	Дополнительная информация

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

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

Номер ошибки	http-код	Краткое описание ошибки	Детальное описание ошибки
620001	400	По данному заказу отмена доставки груза от адреса недоступна	-
620002	400	По данному заказу отмена доставки груза от адреса недоступна	Изменение по данному заказу недоступно в связи с отсутствием доступа

Отмена доставки до адреса получателя

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

Структура запроса

JSON
XML

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "orderID":"00000000",
   "requester":"customer",
   "contactIDs":[
      12345678,
      78456123
   ],
   "contactPersons":[
      {
         "name":"Иван Иванович"
      },
      {
         "name":"Петр Петрович"
      }
   ],
   "phoneIDs":[
      98765412,
      65478921
   ],
   "phoneNumbers":[
      {
         "number":"79213332211",
         "ext":"0123"
      }
   ]
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <orderID>00000000</orderID>
   <requester>customer</requester>
   <contactIDs>12345678</contactIDs>
   <contactIDs>78456123</contactIDs>
   <contactPersons>
      <name>Иван Иванович</name>
   </contactPersons>
   <contactPersons>
      <name>Петр Петрович</name>
   </contactPersons>
   <phoneIDs>98765412</phoneIDs>
   <phoneIDs>65478921</phoneIDs>
   <phoneNumbers>
      <number>79213332211</number>
      <ext>0123</ext>
   </phoneNumbers>
</request>

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

Request

Request
Параметр	Обязательный	Тип	Описание
appkey	Да	string	Ключ приложения. Для получения ключа необходимо пройти регистрацию
sessionID	Да	string	ID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя"
orderID	Да	string	Номер заказа, по которому необходимо отменить доставку до адреса, или же номер соответствующего документа - накладной/заявки на доставку
requester	Да	string	Роль пользователя, подающего запрос на отмену доставки. Доступные значения: "sender" - отправитель; "receiver" - получатель; "customer" - заказчик
contactIDs	Нет*	array of integers	Список ID контактных лиц из "Адресной книги". Максимальное количество элементов в массиве - 3 *Если перевозку отменяет заказчик (значение параметра "requester" - "customer"), то передача одного из взаимоисключающих параметров: "contactIDs" или "contactPersons" - обязательна
contactPersons	Нет*	array of contactPersons	Данные контактных лиц. Максимальное количество элементов в массиве - 3 *Если перевозку отменяет заказчик (значение параметра "requester" - "customer"), то передача одного из взаимоисключающих параметров: "contactIDs" или "contactPersons" - обязательна
contactPersons.name	Да	string	Имя контактного лица
phoneIDs	Нет*	array of integers	Список ID телефонных номеров из "Адресной книги". Максимальное количество элементов в массиве - 3 *Если перевозку отменяет заказчик (значение параметра "requester" - "customer"), то передача одного из взаимоисключающих параметров: "phoneIDs" или "phoneNumbers" - обязательна
phoneNumbers	Нет*	array of phoneNumbers	Список телефонных номеров. Максимальное количество элементов в массиве - 3 *Если перевозку отменяет заказчик (значение параметра "requester" - "customer"), то передача одного из взаимоисключающих параметров: "phoneIDs" или "phoneNumbers" - обязательна
phoneNumbers.number	Да	string	Номер телефона. Максимум 15 знаков (допускаются цифры и знак "+" в начале строки)
phoneNumbers.ext	Нет	string	Добавочный номер. Максимум 5 цифр

Ответ метода

Структура ответа

JSON
XML

{
   "metadata":{
      "status":200,
      "generated_at":"2019-11-18 12:52:26"
   },
   "data":{
      "status":"success",
      "info": "Запрос принят. По результату его обработки, груз будет доступен для получения на терминале."
   }
}

<response>
   <metadata>
      <status>200</status>
      <generated_at>2019-11-18 12:52:26</generated_at>
   </metadata>
   <data>
      <status>success</status>
      <info>Запрос принят. По результату его обработки, груз будет доступен для получения на терминале.</info>
   </data>
</response>

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

Response

Response
Параметр	Тип	Описание
metadata	object	Системная информация
metadata.status	integer	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200". В случае ошибки - "400"
metadata.generated_at	string	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
data	object	Подтверждение успешности операции
data.status	string	Статус операции на английском языке. Возможное значение - "success" Статус "success" означает, что заявка на внесение изменений была принята. После дополнительной проверки заявка может быть одобрена или отклонена. Проверить статус заявки можно при помощи метода "История изменений заказа".
data.info	string	Дополнительная информация

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

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

Номер ошибки	http-код	Краткое описание ошибки	Детальное описание ошибки
615001	400	По данному заказу отмена доставки груза до адреса недоступна	-
615002	400	По данному заказу отмена доставки груза до адреса недоступна	Изменение по данному заказу недоступно в связи с отсутствием доступа
615003	400	Указанная роль заказчика для данного заказа недоступна	-
615004	400	Нет доступа к контрагенту заказа	-
615014	400	Ошибка наложенного платежа	Детальное описание ошибки см. в поле "detail" ответа

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

Отмена заказа и доставки груза до адреса получателя

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

Отмена доставки от адреса отправителя

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

Структура запроса

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

Request

Ответ метода

Структура ответа

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

Response

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

Отмена доставки до адреса получателя

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

Структура запроса

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

Request

Ответ метода

Структура ответа

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

Response

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