I. Области интеграции

Интеграционный гид DPD
Версия: 1.13
Июнь 2015 г.
Оглавление
Интеграционный гид DPD ........................................................................ Error! Bookmark not defined.
Оглавление ................................................................................................................................................2
История обновлений ................................................................................................................................9
Введение...................................................................................................................................................10
Области интеграции.......................................................................................................................11
I.
1.
Запрос географии обслуживания ...........................................................................................11
2.
Расчёт стоимости доставки......................................................................................................11
3.
Создание заказа на доставку ..................................................................................................11
4.
Изменение заказа на доставку ................................................................................................12
5.
Отслеживание статуса доставки ............................................................................................12
6.
Отчеты ...........................................................................................................................................12
7.
Печать наклейки .........................................................................................................................12
8.
Отмена заказа .............................................................................................................................13
9.
Справочная информация .........................................................................................................13
Предикт .....................................................................................................................................13
10.
II.
Пример схемы взаимодействия ..................................................................................................14
III.
Этапы интеграции.......................................................................................................................16
IV.
Руководство разработчика .......................................................................................................17
1.
Веб-служба «География DPD»................................................................................................17
1.1.
Описание ..............................................................................................................................17
1.2.
Расположение .....................................................................................................................17
1.3.
Доступные методы .............................................................................................................17
1.4.
Алгоритм ...............................................................................................................................18
1.5.
Сообщения ...........................................................................................................................18
1.5.1.
Параметры входного сообщения ................................................................................18
1.5.2.
Параметры ответа getCitiesCashPay .........................................................................18
1.5.3.
Параметры ответа getTerminalsSelfDelivery2 ..........................................................18
1.5.4.
Параметры входного сообщения getParcelShops ..................................................19
1.5.5.
Параметры ответа getParcelShops.............................................................................20
1.5.6.
Параметры входного сообщения getParcelShops
(http://ws.dpd.ru/services/geography2?wsdl ) ..................................................................................20
2
1.5.7. Параметры выходного сообщения getParcelShops
(http://ws.dpd.ru/services/geography2?wsdl ) ..............................................................................21
1.5.7.1.
Описание типа address..............................................................................................21
1.5.7.2.
Описание типа geoCoordinates ................................................................................22
1.5.7.3.
Описание типа limits ...................................................................................................22
1.5.7.4.
Описание типа schedule ............................................................................................22
1.5.7.5.
Описание типа timetable............................................................................................22
Описание типа terminales .............................................................................................22
1.5.7.6.
1.5.7.7.
1.5.8.
Описание типа service ...............................................................................................23
Описание атрибутов ответного сообщения getParcelShops ....................................23
1.5.8.1.
Список возможных типов подразделения ................................................................23
1.5.8.2.
Список возможный состояний пункта ........................................................................23
1.5.8.3.
Возможные варианты операций .................................................................................23
1.5.9.
Параметры выходного сообщения getTerminalsSelfDelivery2 ............................23
1.1.1.
Параметры входного сообщения getStoragePeriod....................................................23
1.1.2.
Параметры выходного сообщения getStoragePeriod................................................24
1.1.2.1.
1.1.3.
Параметры исходящего сообщения при ошибках getStoragePeriod .....................24
1.1.3.1.
2.
Справочник сообщений об ошибках ......................................................................24
Веб-служба «Расчёт стоимости» ............................................................................................26
2.1.
Описание ..............................................................................................................................26
2.2.
Расположение .....................................................................................................................26
2.3.
Доступные методы .............................................................................................................26
2.4.
Алгоритмы ............................................................................................................................26
2.4.1.
Рассчитать общую стоимость доставки ....................................................................26
2.4.2.
Рассчитать стоимость доставки по параметрам посылок ....................................26
2.5.
Сообщения ...........................................................................................................................27
2.5.1.
Параметры входного сообщения для getServiceCost2 .........................................27
2.5.2.
Параметры входного сообщения для getServiceCostByParcels2 .......................28
2.5.3.
Параметры ответа при ошибке ...................................................................................30
2.5.4.
Параметры ответа при успешном запросе ..............................................................30
2.6.
2.6.1.
3.
Описание типа service ...............................................................................................24
Типы .......................................................................................................................................31
Описание типа parcel .....................................................................................................31
Веб-служба «Создание заказа» ..............................................................................................32
3
3.1.
Описание ..............................................................................................................................32
3.2.
Расположение .....................................................................................................................32
3.3.
Доступные методы .............................................................................................................32
3.4.
Алгоритмы ............................................................................................................................32
3.4.1.
Создание заказа на доставку ......................................................................................32
3.4.2.
Создание адреса с кодом .............................................................................................33
3.4.3.
Изменение адреса с кодом ..........................................................................................33
3.5.
Сообщения ...........................................................................................................................33
3.5.1.
Параметры входного сообщения createOrder .........................................................33
3.5.2.
Параметры входного сообщения getOrderStatus ...................................................35
3.5.3.
Параметры ответного сообщения createOrder \ getOrdersStatus .......................36
3.5.4.
Параметры входного сообщения createAddress \ updateAddress .......................36
3.5.5.
Параметры ответного сообщения createAddress \ updateAddress .....................36
3.5.6.
Параметры входного сообщения getInvoiceFile ......................................................37
3.5.7.
Параметры ответного сообщения getInvoiceFile ....................................................37
3.5.8.
Параметры входного сообщения getRegisterFile ....................................................37
3.5.9.
Параметры ответного сообщения getRegisterFile ..................................................37
3.5.10.
3.6.
Параметры ответа при ошибке ...............................................................................38
Типы .......................................................................................................................................38
3.6.1.
Описание типа address..................................................................................................38
3.6.2.
Описание типа dataInternational ......................................................................................39
3.6.3.
Описание типа extraService ..........................................................................................40
3.6.4.
Описание типа parameter ..............................................................................................40
3.6.5.
Описание типа parcel .....................................................................................................40
3.6.6.
Описание типа unitLoad.................................................................................................40
3.7.
Варианты доставки.............................................................................................................40
3.8.
Интервалы времени приёма ............................................................................................40
3.9.
Интервалы времени доставки .........................................................................................41
3.10.
Варианты формы оплаты .............................................................................................41
3.11.
Услуги DPD .......................................................................................................................41
3.12.
Опции .................................................................................................................................41
3.12. Справочник параметров ..........................................................................................................43
3.13.
Статусы создания заказа ..............................................................................................44
3.14.
Статусы создания и изменения адреса ....................................................................44
4
Веб-служба «Изменение заказа» ...........................................................................................45
4.
4.1.
Описание ..............................................................................................................................45
4.2.
Расположение .....................................................................................................................45
4.3.
Доступные методы .............................................................................................................45
4.4.
Алгоритмы ............................................................................................................................45
4.4.1.
Изменение заказа с добавлением посылок .............................................................45
4.4.2.
Изменение заказа с удалением посылок..................................................................45
Сообщения ...........................................................................................................................45
4.5.
4.5.1.
Параметры входного сообщения addParcels \ removeParcels .............................45
4.5.2.
Параметры ответного сообщения для addParcels \ removeParcels ...................46
Типы .......................................................................................................................................46
4.6.
4.6.1.
Описание типа parcel .....................................................................................................46
4.6.2.
Описание типа parcelStatus..........................................................................................46
Статусы .................................................................................................................................47
4.7.
4.7.1.
Статусы изменения заказа ...........................................................................................47
4.7.2.
Статусы добавления \ удаления посылки ................................................................47
Веб-служба «Отслеживание статуса» ...................................................................................48
5.
5.1.
Описание ..............................................................................................................................48
5.2.
Расположение .....................................................................................................................48
5.3.
Доступные методы .............................................................................................................48
5.4.
Алгоритмы ............................................................................................................................49
5.4.1.
Алгоритм работы с методом getStatesByClient .......................................................49
5.4.2. Алгоритм работы с методами getStatesByClientOrder, getStatesByDPDOrder,
getStatesByClientParcel ..................................................................................................................49
a.
Входящие сообщения ............................................................................................................49
5.4.3.
getStatesByClient .............................................................................................................49
5.4.4.
confirm ................................................................................................................................50
5.4.5.
getStatesByClientOrder ...................................................................................................50
5.4.6.
getStatesByClientParcel ..................................................................................................50
5.4.7.
getStatesByDPDOrder .....................................................................................................51
5.5.
Исходящие сообщения......................................................................................................51
5.5.1.
getStatesByClientResponse ...........................................................................................51
5.5.2.
confirmResponse ..............................................................................................................53
5.5.3.
getStatesByClientOrderResponse .................................................................................53
5
5.5.4.
getStatesByClientParcelResponse ................................................................................53
5.5.5.
getStatesByDPDOrderResponse ...................................................................................53
5.6.
5.6.1.
6.
6.1.
Описание ..............................................................................................................................55
6.2.
Расположение .....................................................................................................................55
6.3.
Доступные методы .............................................................................................................55
6.4.
Алгоритмы ............................................................................................................................55
6.5.
Сообщения ...........................................................................................................................55
6.5.1.
Параметры входного сообщения метода .................................................................55
6.5.2.
Параметры ответного сообщения метода getNLAmount ......................................55
6.5.3.
Параметры ответного сообщения метода getNLInvoice .......................................56
Ограничение на частоту вызовов ...................................................................................56
Веб-служба «Печать Наклейки» .............................................................................................57
7.1.
Описание ..............................................................................................................................57
7.2.
Расположение .....................................................................................................................57
7.3.
Доступные методы .............................................................................................................57
7.4.
Алгоритмы ............................................................................................................................57
7.4.1.
Формат файла .................................................................................................................57
7.4.2.
Формат области печати.................................................................................................57
7.5.
7.5.1.
7.6.
7.6.1.
8.
Посылка.............................................................................................................................53
Веб-служба «Отчеты» ...............................................................................................................55
6.6.
7.
Состояния .............................................................................................................................53
Входящие сообщения ........................................................................................................57
createLabelFile..................................................................................................................57
Исходящие сообщения......................................................................................................58
createLabelFileResponse................................................................................................58
Веб-служба «Отмена заказа» ..................................................................................................59
8.1.
Описание ..............................................................................................................................59
8.2.
Расположение .....................................................................................................................59
8.3.
Доступные методы .............................................................................................................59
8.4.
Алгоритмы ............................................................................................................................59
8.5.
Входящие сообщения ........................................................................................................59
8.6.
Параметры ответного сообщения ..................................................................................60
8.7.
Статусы .................................................................................................................................60
8.8.
Текст сообщений об ошибке ............................................................................................60
6
Веб-служба «Справочная информация» ..............................................................................61
9.
9.1.
Описание ..............................................................................................................................61
9.2.
Расположение .....................................................................................................................61
9.3.
Доступные методы .............................................................................................................61
9.4.
Алгоритмы ............................................................................................................................61
9.5.
Входящее сообщения ........................................................................................................61
9.6.
Параметры ответного сообщения ..................................................................................61
9.7.
Статусы .................................................................................................................................62
10.
V.
Веб-служба «Предикт» ..........................................................................................................62
10.1.
Описание ..........................................................................................................................62
10.2.
Расположение .................................................................................................................62
10.3.
Доступные методы .........................................................................................................62
10.4.
Алгоритмы ........................................................................................................................63
10.5.
Входящее сообщение метода getShipmentList .......................................................63
10.6.
Параметры ответного сообщения getShipmentList ................................................64
10.7.
Входящее сообщение для 11 методов API ..............................................................64
10.8.
Параметры ответного сообщения IsAddressChangeable ......................................64
10.9.
Параметры ответного сообщения getDeliveryDate .................................................65
10.10.
Параметры ответного сообщения getDeliveryIntervalList ......................................65
10.11.
Параметры ответного сообщения getParselShopList .............................................65
10.12.
Параметры ответного сообщения getAddress .........................................................65
10.13.
Параметры ответного сообщения getStreetList.......................................................66
10.14.
Параметры ответного сообщения saveDeliveryDate ..............................................66
10.15.
Параметры ответного сообщения getWebSite ........................................................67
10.16.
Параметры ответного сообщения cancelOrder .......................................................67
10.17.
Параметры ответного сообщения saveAddress ......................................................67
10.18.
Параметры ответного сообщения getDeliveryDateList ..........................................67
10.19.
Статусы сообщений ......................................................................................................67
Справочник ошибок ........................................................................................................................68
1.
Общие ошибки.........................................................................................................................68
2.
Ошибки службы «Расчёт стоимости» ................................................................................68
3.
Ошибки службы «Создание заказа» ..................................................................................68
4.
Ошибки службы «Отслеживание статуса» .......................................................................69
5.
Ошибки службы «Создание адреса с кодом» .................................................................69
7
6.
VI.
Ошибки службы «Печать Наклейки» .................................................................................69
Контакты........................................................................................................................................70
8
История обновлений
Версия 1.8
 новая веб-служба «Отмена заказа» (CancelOrder).
Версия 1.9
 метод getTerminalSelfDelivery2 – расширен список параметров ответного сообщение
(отображение координат нахождения терминалов, времени работы терминалов, код КЛАДР
населенного пункта нахождения терминала);
 веб-служба «Расчет стоимости» - добавлена расшифровка кодов услуг DPD;
 добавлены наименования оборотов для каждого метода;
 примеры интеграции вынесены в отдельные документы.
Версия 1.10

для методов getNLAmount и getNLInvoice отменены ограничения только ночного запуска.
Отчеты можно запускать в любое время суток. Введены ограничения на частоту запуска
отчетов;
 новый метод getRegisterFile в веб-службе «Создание заказа» - позволяет получать реестр
отправок, передаваемых курьеру DPD.
Версия 1.11
 метод createOrder – добавлено описание параметров и их значений для различных
вариантов оплаты наличными.
 метод createOrder – описание параметров и значений для опции ЧСТ; описание
параметров для добавления вложений – unitLoad.
Версия 1.12
 новая веб-служба «Справочная информация». Метод getClientNumByINN – определение
клиентского номера в системе DPD по ИНН (для оформления заказов с оплатой не
заказчиками).
9
Введение
Компания DPD предоставляет ряд стандартных решений для интеграции своей
информационной системы с информационными системами клиентов. Такого рода интеграция
позволяет нашим компаниям обмениваться необходимыми данными в реальном времени и
исключает обработку данных вручную, что значительно ускоряет и оптимизирует бизнеспроцесс. Мы предлагаем воспользоваться простым и быстрым доступом к функциям нашей
системы, которые включают в себя расчет стоимости доставки, отслеживание посылок,
создание заказов на доставку и получение информации о географии обслуживания.
Базовый принцип взаимодействия представлен на следующем рисунке:
Онлайн запрос
Информационная
система клиента
DPD
Ответ программы
Интеграционный
модуль DPD
Прямое
взаимодействие
Информационная
система DPD
Интеграционный модуль DPD представляет собор набор веб-служб, построенных на базе
технологий SOAP и REST и развернутых на серверах приложений Tomcat.
Подробнее про веб-службы и про технологию SOAP можно прочитать, например, здесь:
http://www.webmascon.com/topics/technologies/8a.asp
10
I. Области интеграции
На данный момент существуют девять областей интеграции с информационной системой DPD:
1.
2.
3.
4.
5.
6.
7.
8.
9.
Запрос географии обслуживания
Расчёт стоимости доставки
Создание заказа на доставку
Изменение заказа
Отслеживание статуса доставки
Отчеты
Печать Наклейки
Отмена заказа
Справочная информация
1. Запрос географии обслуживания
Запрос географии обслуживания подразумевает получение информации о географии доставки
DPD в реальном времени. Эта область интеграции поддерживает два метода:


Получение списка городов, в которых расположены терминалы DPD.
Получение списка городов, в которые осуществляется доставка с наложенным
платежом.
2. Расчёт стоимости доставки
Интеграция в области расчёта стоимости нужна для того, чтобы ваша информационная
система в любой момент могла получить актуальную стоимость доставки и при необходимости
предоставить эту стоимость своему клиенту. Входящие в состав области методы позволяют:



Выполнить расчёт стоимости доставки по выбранному направлению и услуге. Это
актуально, если вы постоянно пользуетесь одной услугой для доставки. Для расчета
стоимости необходимо выбирать лишь направление.
Получить список доступных услуг и их стоимость для выбранного направления.
Выполнить более точный расчет стоимости доставки на основе данных посылок. Это
актуально, если вы точно знаете количество, габариты и веса ваших посылок.
3. Создание заказа на доставку
Создание заказа на доставку с помощью интеграционного модуля позволяет максимально
быстро передать в нашу систему необходимую информацию для формирования отправки.
Например, как только пользователь интернет-магазина подтверждает свой заказ,
информационная система магазина генерирует онлайн запрос, в котором передает все
необходимые сведения: дату вызова курьера, адрес приёма груза, адрес доставки и т.п.
Интеграционный модуль DPD примет заявку на создание заказа и в ответном запросе сообщит
статус создания заказа, ошибки создания заказа (если заказ не создан) и номер заказа в
информационной системе DPD (если заказ создан корректно).
Статус создания заказа может быть следующим: заказ создан корректно, заказ отклонен из-за
ошибок, или заказ принят на доработку. Последний статус означает, что мы не смогли
автоматически принять заказ (например, потому что наша система не смогла распознать адрес
доставки), и ваш запрос будет обработан нашим сотрудником вручную, который уточнит и
поправит всю необходимую информацию и завершит процесс создания заказа.
Данная область поддерживает методы:
11




Создание заказов на доставку.
Проверка статуса создания заказа и получение его номера. Этот метод необходим для
тех случаев, когда заказ не был создан автоматически и был позднее доработан
сотрудником DPD.
Создание адресов с кодом. Данный метод необходим в случае, если есть адрес,
который часто используется в заказе и вместо него проще передавать код адреса.
Изменение адрес с кодом. Данный метод необходим в случае, когда закрепленный за
кодом адрес изменился.
4. Изменение заказа на доставку
Изменение заказа на доставку с помощью интеграционного модуля позволяет максимально
оперативно передать в нашу систему изменившуюся информацию для корректировки данных
заказа. Изменения данных заказа возможны до момента получения груза на терминале
компании.
Статус изменения заказа может быть следующим: заказ изменен успешно, состояние заказа не
позволяет выполнять его корректировку. Последний статус означает, что груз уже был
получен от клиента компанией.
Данная область поддерживает два метода:


Создание заказов на доставку.
Проверка статуса создания заказа и получение его номера. Этот метод необходим для
тех случаев, когда заказ не был создан автоматически и был позднее доработан
сотрудником DPD.
5. Отслеживание статуса доставки
Область отслеживания статуса доставки предоставляет две основные возможности: вы
можете позволить своему клиенту отслеживать статус его доставки в реальном времени, и вы
можете в любое время получать актуальные сведения о статусе всех своих доставок.
Данная область поддерживает три метода:



Получение статусов ваших посылок, изменившихся с момента предыдущего запроса.
Необходимо указать ваш клиентский номер.
Получение статусов посылок по указанному заказу. Информация предоставляется
как по номеру вашего заказа, так и по номеру заказа DPD.
Получение статусов конкретной посылки. Информация предоставляется по
номеру/штрих-коду вашей посылки.
6. Отчеты
Данная область позволяет получать необходимые Вам отчеты по запросу.
Входящие в состав области методы позволяют получить следующие отчеты:


О предварительной стоимости перевозки отправок за период времени.
Об окончательной стоимости перевозки отправок за период времени с номерами
счетов.
7. Печать наклейки
Данная область предоставляет вам возможность посредством сервиса формировать наклейки
DPD по ранее созданному заказу.
12
8. Отмена заказа
Данная область предоставляет вам возможность посредством сервиса отменять заказы без звонка
в Call центр DPD.
9. Справочная информация
Данная область предоставляет возможность оперативно получить различную информацию, в том
числе получить номер клиента по номеру ИНН компании.
10.
Предикт
Данная область предоставляет возможность Изменение заказа на доставку с помощью
интеграционного модуля позволяет максимально оперативно передать в нашу систему
изменившуюся информацию для корректировки данных заказа. Изменения данных заказа
возможны до момента получения груза.
Статус изменения заказа описаны в пункте 10.19 данного Документа.
Данная область поддерживает методы:



Изменение даты доставки.
Изменение времени доставки.
Изменения адреса доставки.
13
II. Пример схемы взаимодействия
Следующая схема описывает взаимодействие с использованием всех областей интеграции на
примере клиента - интернет-магазина.
Выб
о р сл
ужбы
д о ст
авки
Запр
ос
обсл географи
ужив
и
ания
Пользователь
интернет-магазина
Интеграционный
модуль DPD
Сайт интернет-магазина
Подтверждение
возможности доставки DPD
Ра
с
чё
т
до стои
ста мо
вки сти
ь
мост
Стои авки
т
д ос
ос ра
Запр
тве
р
за жде
каз ни
е
а
з
со
тв
Запр
ие
ен а
жд аказ
р
е
з
счёт
а сто
имос
ти
ть
ос
им вки
о
Ст оста
д
По
д
д
По
ых
пн
у
т
ос
к д ов
со о р о д
и
г
Сп
да
ос н а
со
зака здание
за
я
ни
шн
пе
ус а з а
б
о з ак
ие
ен ании
щ
об з д
С о со
14
ом
Отслеж
ив
ание с
т
заказа атуса
Запрос
ние
стоя
ее со ки
щ
у
к
ав
Те
д о ст
статус
ап
по зака осылок
зу
ий
тоян
я сос заказу
и
р
о
Ист лки по
посы
15
III. Этапы интеграции
Для запуска интеграционного процесса с DPD вам нужно совершить следующие действия:
1. Передать данное руководство в ваш IT-департамент.
2. Разработать клиентскую программу для взаимодействия с выбранными веб-службами.
3. Получить уникальный ключ клиента для аутентификации в интеграционном модуле DPD.
Для получения данного ключа вам нужно иметь клиентский номер DPD (номер вашего
договора с DPD). Вы можете получить ключ у своего менеджера DPD или обратившись на
адрес нашей информационной поддержки: itcustomers@dpd.ru
4. Протестировать работу веб-служб совместно с сотрудниками информационной поддержки
DPD, используя тестовый сервер DPD. Адрес тестового сервера приведен ниже в
руководстве разработчика.
5. Настроить вашу программу на промышленный сервер DPD и начать работать в реальном
режиме. Адрес промышленного сервера приведен ниже в руководстве разработчика.
16
IV.Руководство разработчика
В данном разделе дано подробное описание методов, имеющихся в веб-службах.
1. Веб-служба «География DPD»
1.1. Описание
Веб-служба «География DPD» предназначена для получения актуального списка городов, в
которые возможна доставка с наложенным платежом, списка терминалов DPD и списка пунктов
выдачи посылок (ПВП), а также списка пунктов приема/выдачи посылок с указанием режима
работы пункта для самопривоза/самовывоза.
1.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/geography?wsdl
http://wstest.dpd.ru/services/geography2?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/geography?wsdl
http://ws.dpd.ru/services/geography2?wsdl
1.3. Доступные методы
Метод
getCitiesCashPay
getTerminalsSelfDelivery2
http://ws.dpd.ru/services/g
eography2?wsdl
getParcelShops
http://ws.dpd.ru/services/g
eography2?wsdl
getTerminalsSelfDelivery2
http://ws.dpd.ru/services/g
eography2?wsdl
getStoragePeriod
http://ws.dpd.ru/services/g
eography2?wsdl
Назначение
Получить список городов с
возможностью доставки с
наложенным платежом
Получить список
подразделений DPD
Получить список пунктов
приема/выдачи посылок,
имеющих ограничения по
габаритам и весу, с
указанием режима работы
пункта и доступностью
выполнения
самопривоза/самовывоза.
При работе с методом
необходимо проводить
получение информации по
списку подразделений
ежедневно.
Получить список
подразделений DPD, не
имеющих ограничений по
габаритам и весу посылок
приема/выдачи
Получить информацию о
срок бесплатного хранения
на пункте
17
Входящее
сообщение
Параметры
входного
сообщения
Параметры
входного
сообщения
Параметры
входного
сообщения
Ответное
сообщение
Параметры ответа
getCitiesCashPay
Параметры
входного
сообщения
Параметры ответа
getTerminalsSelfDeli
very2
Параметры
входного
сообщения
Параметры
ответа/Параметры
ответа при ошибке
Параметры ответа
getTerminalsSelfDeli
very2
Параметры
выходного
сообщения
1.4. Алгоритм
1. Подготавливаем данные для аутентификации входного запроса и вызываем нужный метод.
2. Обрабатываем результат в соответствии со спецификацией ответных сообщений
выбранного метода.
1.5. Сообщения
1.5.1. Параметры входного сообщения
Параметр
Описание
Тип
Обязательный
Пример
Auth
clientNumber
clientKey
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Строка
Да
1000000000
Строка
Да
1FD890C3556
1.5.2. Параметры ответа getCitiesCashPay
Параметр
city
cityId
countryCode
countryName
regionCode
regionName
Описание
Массив городов с
поддержкой доставки с
наложенным платежом
Идентификатор города
Код страны
Страна
Код региона
Регион
Тип
Пример
Число
Строка
Строка
Строка
Строка
195644235
RU
Россия
50
Московская обл.
(формат ФИАС)
50017001000
Строка
cityName
Код населенного
пункта
Населенный пункт
abbreviation
indexMin
indexMax
Аббревиатура
Минимальный индекс
Максимальный индекс
Строка
Строка
Строка
cityCode
Строка
Люберцы (буквенные
обозначения
аббревиатур и других
знаков)
г
140000
143818
1.5.3. Параметры ответа getTerminalsSelfDelivery2
Параметр
terminal
terminalCode
terminalName
terminalAddres
s
geoCoordinate
s:
Описание
Массив терминалов
DPD
Код терминала DPD
Название терминала
DPD
Адрес терминала DPD
Тип
Пример
Строка
Строка
LED
Санкт-Петербург
Строка
пр. Обуховской
Обороны, д.295, лит БД
192012 г. СанктПетербург
Число
Число
53.322927
83.638803
Географические
координаты по карте
Яндекс
geoX
geoY
18
Параметр
workingTime:
Описание
Массив расписаний
работы по дням
Список дней недели
Тип
Пример
Строка
Строка
пн,вт,ср,чт,пт
09:00–20:00
cityId
cityCode
countryCode
countryName
regionCode
regionName
Информация о городе,
в котором расположен
терминал DPD
Идентификатор города
Код города
Код страны
Страна
Код региона
Регион
Число
Строка
Строка
Строка
Строка
Строка
cityName
Город
Строка
49694103
78000000001
RU
Россия
78
г. Санкт-Петербург
(формат ФИАС)
Санкт-Петербург
(буквенные
обозначения
аббревиатур и других
знаков)
weekDays
workTime
сity
1.5.4. Параметры входного сообщения getParcelShops
Параметр
Внешний тэг request
auth
clientNumber
clientKey
countryCode
regionCode
cityCode
cityName
serviceCode
Описание
Тип
Обязательный
Пример
Ваш клиентский
номер в системе
DPD (номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Код страны
Код региона
Код города
Наименование
города
Строка
Да
1000000000
Строка
Да
1FD890C3556
Строка
Строка
Нет
Нет
RU
77
Строка
Нет
Список кодов услуг
DPD. Если параметр
задан, то сервис
возвращает сроки
бесплатного
хранения по
заданным услугам.
Если он не задан,
сервис не
возвращает сроки
бесплатного
хранения.
Строка
Нет
Москва
(буквенные
обозначения
аббревиатур
и других
знаков)
BZP, ECN
Список
кодов
услуг
через
запятую
ПРИМЕЧАНИЯ. 1. Поля countryCode, regionCode и cityCode задаются для фильтрации списка.
Если коды не заданы, возвращается полный список. Поле cityName анализируется только, если не
задан cityCode.
19
2. Сроки бесплатного хранения зависят от услуги DPD и одинаковы для всех пунктов. Для
получения сроков бесплатного хранения необходимо задать поле serviceCode.
1.5.5. Параметры ответа getParcelShops
Параметр
parcelShop
countryCode
regionCode
regionName
Описание
Массив ПВП
Код подразделения
DPD
Тип подразделения:
Т–терминал, СД–ситидепо, ПВП–отдельный
пункт выдачи посылок
Адрес пункта
Код страны
Код региона
Регион
cityCode
cityName
Код города
Город
Строка
Строка
addressString
Строка с адресом
Строка
code
parcelShopTy
pe
address
Тип
Пример
Строка
LED
Строка
ПВП
Строка
Строка
Строка
RU
78
г. СанктПетербург
(формат
ФИАС)
78000000001
СанктПетербург
(буквенные
обозначения
аббревиатур
и других
знаков)
пр. Обуховской
Обороны,
д.295, лит БД
192012 г.
СанктПетербург
Географические
координаты по карте
Яндекс
geoCoordinat
es
geoX
geoY
limits
maxWeight
maxLength
maxWidth
maxHeight
workingTime
weekDays
workTime
Ограничения
параметров посылки
Макс. вес в кг
Макс. длина в см
Макс. ширина в см
Макс. высота в см
Массив расписаний
работы по дням
Список дней недели
Массив сроков
бесплатного
хранения
Код услуги
Количество дней
storagePeriod
serviceCode
days
Число
Число
53.322927
83.638803
Число
Число
Число
Число
30.5
70
70
50
Строка
Строка
пн,вт,ср,чт,пт
09:00–20:00
Строка
Число
CSM
14
1.5.6. Параметры входного сообщения getParcelShops
(http://ws.dpd.ru/services/geography2?wsdl )
Параметр
auth
clientNumber
Описание
Тип
Обязательный
Пример
Ваш клиентский
Строка
Да
1000000000
20
Параметр
Описание
номер в системе
DPD (номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Код страны
Код региона
Код города
Наименование
города
clientKey
countryCode
regionCode
cityCode
cityName
Тип
Обязательный
Пример
Строка
Да
1FD890C3556
Строка
Строка
Нет
Нет
RU
77
Строка
Нет
Москва
(буквенные
обозначения
аббревиатур
и других
знаков)
1.5.7.Параметры выходного сообщения getParcelShops
(http://ws.dpd.ru/services/geography2?wsdl )
Параметр
Описание
parcelShop
Массив ПВП и
пунктов
code
Код подразделения
DPD
parcelShopTy
Тип подразделения.
pe
Варианты типов
подразделений
state
Состояние
подразделения
Варианты состояний
address
Адрес пункта
geoCoordinat
Географические
es
координаты по карте
Яндекс
limits
Ограничения
параметров посылки
schedule
Массив операций
производственного
подразделения
1.5.7.1.
Параметр
Описание типа address
Описание
Тип
Пример
Строка
LED
Строка
П
Строка
Open
address
geoCoordi
nates
limits
schedule
Тип
Пример
countryCode
Код страны
Строка
RU
regionCode
Код региона
Строка
77
regionName
Регион
Строка
cityCode
Код города
Строка
г. Москва (формат
ФИАС)
77000000000
cityName
Город
Строка
street
Наименование улицы
Строка
21
Москва (буквенные
обозначения
аббревиатур и
других знаков)
Земляной Вал
Параметр
Описание
Тип
Пример
streetAbbr
Аббревиатура улицы
Строка
ул
houseNo
Номер дома
Строка
7
building
Корпус
Строка
structure
Строение
Строка
ownership
Владение
Строка
Описание типа geoCoordinates
Описание
Тип
1.5.7.2.
Параметр
Пример
latitude
Широта
Число
53.322927
longitude
Долгота
Число
83.638803
Тип
Пример
Число
30.5
Число
5.5
maxLength
Макс. вес отправки в
кг
Макс. Вес посылки в
кг
Макс. длина в см
Число
70
maxWidth
Макс. ширина в см
Число
70
maxHeight
Макс. высота в см
Число
50
Тип
Пример
Строка
SelfDelivery
Описание типа limits
Описание
1.5.7.3.
Параметр
maxShipmentWeight
maxWeight
1.5.7.4.
Параметр
Описание типа schedule
Описание
Наименование
операции
Варианты операций
Массив расписания
для операции
operation
timetable
1.5.7.5.
Параметр
Описание типа timetable
Описание
timetable
Тип
Пример
weekDays
Список дней недели
Строка
пн,вт,ср,чт,пт
workTime
Список времени
работы
Строка
09:00–20:00
1.5.7.6.
Параметр
terminales
Описание типа terminales
Описание
Массив подразделений с
указанием срока хранения
terminalCоde
Код пункта приема/выдачи
services
Массив услуг
22
Тип
Пример
Строка
service
41W
1.5.7.7.
Параметр
Описание типа service
Описание
Тип
Пример
serviceCode
Код услуги
Строка
PCL
days
Количество дней
Число
3
1.5.8.Описание атрибутов ответного сообщения getParcelShops
1.5.8.1.


П – почтомат
ПВП – пункт приема/выдачи посылок
1.5.8.2.


Список возможный состояний пункта
open (Открыт)
full (Переполнен)
1.5.8.3.


Список возможных типов подразделения
Возможные варианты операций
SelfPickup – прием посылок
SelfDelivery – выдача посылок
1.5.9.Параметры выходного сообщения getTerminalsSelfDelivery2
Параметр
Описание
Тип
Пример
terminal
Массив терминалов
DPD
terminalCode
Код терминала DPD
Строка
M13
terminalName
Название терминала
Строка
Москва
DPD
address
Адрес пункта
address
geoCoordinate
Географические
geoCoordi
s
координаты по карте
nates
Яндекс
schedule
Массив операций
schedule
производственного
подразделения
1.1.1.Параметры входного сообщения getStoragePeriod
Параметр
Описание
Тип
Обязательный
auth
clientNumber Ваш клиентский Строка
Да
номер в
системе DPD
(номер вашего
договора с
DPD)
clientKey
Ваш
Строка
Да
уникальный
ключ для
авторизации,
полученный у
сотрудника
DPD
23
Пример
1000000000
1FD890C3556
Параметр
terminalCоde
serviceCode
Описание
Код
подразделения
DPD
Код услуги
Тип
Строка
Обязательный
Да
Пример
03Z,OEL
Список кодов
подразделений
через запятую
Строка
Нет
PCL,CSM
Список кодов
услуг через
запятую
1.1.2.Параметры выходного сообщения getStoragePeriod
Параметр
Описание
terminales
Массив
подразделений с
указанием срока
хранения
terminalCоd
Код пункта
e
приема/выдачи
services
Массив услуг
1.1.2.1.
Параметр
Описание типа service
Описание
Тип
Пример
Строка
03Z
service
П
Тип
Пример
serviceCode
Код услуги
Строка
PCL
days
Количество дней
Число
3
1.1.3.Параметры исходящего сообщения при ошибках getStoragePeriod
Параметр
Описание
Тип
Обязател
Пример
ьный
status
Статус
Строка
Да
Ок
errorMessage
Сообщение об ошибке
Строка
Да
В ответном сообщении при передаче информации может быть возвращен один из следующих
статусов:


ОК – информация успешно передана
Код ошибки – информация не может быть обработана по причине, указанной в поле
errorMessage.
1.1.3.1.
Справочник сообщений об ошибках
Код ошибки
Текст ошибки
Примечание
no- terminalCоde-found
Не удалось найти
Некорректно указан код подразделения
указанный код
DPD.
подразделения <Код
Введите верный код услуги и попробуйте
подразделения DPD>
повторно.
no- serviceCode-found
Не удалось найти
Некорректно указан код услуги.
указанный код услуги
Введите верный код услуги и попробуйте
<Код услуги>
повторно.
no- data-found
Нет данных для
По указанным параметрам нет данных в
указанных <Код
системе.
подразделения DPD>,
<Код услуги>
required-value
Не заданы значения
Проверьте алгоритм заполнения всех
24
Код ошибки
Текст ошибки
обязательных полей
25
Примечание
обязательных полей входного
сообщения.
2. Веб-служба «Расчёт стоимости»
2.1. Описание
Веб-служба «Расчёт стоимости» предназначена для расчёта стоимости доставки по тарифам
DPD.
2.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/calculator2?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/calculator2?wsdl
2.3. Доступные методы
Метод
Назначение
getServiceCost2
Рассчитать общую
стоимость доставки
getServiceCostByParcels2
Рассчитать стоимость
доставки по
параметрам посылок
Входящее
сообщение
Параметры
входного
сообщения
Параметры
входного
сообщения
Ответное сообщение
Параметры ответа при
ошибке / Параметры
ответа при успешном
запросе
Параметры ответа при
ошибке / Параметры
ответа при успешном
запросе
2.4. Алгоритмы
2.4.1. Рассчитать общую стоимость доставки
1. Подготавливаем параметры вызова в соответствии с описанием входного сообщения
метода getServiceCost2: пункт отправления и назначения, дату приёма груза,
объявленную ценность. Если вы работаете с DPD только по одной услуге, рекомендуется
указать код этой услуги во входном сообщении.
2. Вызываем метод getServiceCost2.
3. Получаем ответное сообщение с кодом ошибки или с массивом доступных услуг для
выбранной доставки и их стоимости. Если услуга была задана во входном сообщении, то
при успешном выполнении запроса массив ответного сообщения будет состоять из одного
элемента.
4. Если вы получили код ошибки «too-many-rows», то проанализируйте массивы pickupDups и
DeliveryDups во входном сообщении. Выберите ID нужного населенного пункта и повторите
запрос.
2.4.2. Рассчитать стоимость доставки по параметрам посылок
1. Подготавливаем параметры вызова в соответствии с описанием входного сообщения
метода getServiceCostByParcels2: пункт отправления и назначения, дату приёма груза,
объявленную ценность. Если вы работаете с DPD только по одной услуге, рекомендуется
указать код этой услуги во входном сообщении.
2. Вызываем метод getServiceCostByParcels2.
3. Получаем ответное сообщение с кодом ошибки или с массивом доступных услуг для
выбранной доставки и их стоимости. Если услуга была задана во входном сообщении, то
при успешном выполнении запроса массив ответного сообщения будет состоять из одного
элемента.
4. Если вы получили код ошибки «too-many-rows», то проанализируйте массивы pickupDups и
DeliveryDups во входном сообщении. Выберите ID нужного населенного пункта и повторите
запрос.
26
2.5. Сообщения
2.5.1. Параметры входного сообщения для getServiceCost2
Параметр
Внешний тэг request
auth
clientNumber
clientKey
Описание
Тип
Обязательный
Пример
Ваш клиентский
номер в системе
DPD (номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Строка
Да
1000000000
Строка
Да
1FD890C3556
Идентификатор
города отправления
Город отправления
Число
Нет
49694102
Строка
Нет
Код региона
отправления
Код страны
отправления
Строка
Нет
Москва
(буквенные
обозначения
аббревиатур
и других
знаков)
77
Строка
Нет
RU
Идентификатор
города доставки
Город доставки
Число
Нет
49265227
Строка
Нет
Код региона
доставки
Код страны доставки
Самопривоз на
терминал.
Доставка до
терминала.
Самовывоз с
терминала.
Вес отправки, кг
Объём, м3
Список кодов услуг
DPD. Если параметр
задан, то сервис
возвращает
стоимость только
заданных услуг.
Если он не задан –
всех доступных
услуг.
Предполагаемая
дата приёма груза.
Стоимость будет
Строка
Нет
Челябинск
(буквенные
обозначения
аббревиатур
и других
знаков)
74
Строка
boolean
Нет
Да
RU
false
boolean
Да
true
Число
Число
Строка
Да
Нет
Нет
5
0.05
BZP,ECN
Нет
2014-05-21
pickup
cityId
cityName
regionCode
countryCode
delivery
cityId
cityName
regionCode
countryCode
selfPickup
selfDelivery
weight
volume
serviceCode
pickupDate
27
Список
кодов
услуг
через
запятую
Дата
Параметр
maxDays
maxCost
declaredValue
Описание
считаться на
заданную дату. Если
параметр не задан –
будет считаться на
текущую дату.
Максимально
допустимый срок.
Если параметр
задан, то все услуги
с большим сроком
не будут
показываться.
Параметр не имеет
смысла, если
задавать конкретную
услугу.
Максимально
допустимая
стоимость. Если
параметр задан, то
все услуги с
большей
стоимостью не будут
показываться.
Параметр не имеет
смысла, если
задавать конкретную
услугу.
Объявленная
ценность груза
Тип
Обязательный
Пример
Целое
число
Нет
2
Число
Нет
1000
Число
Нет
1000 (после
запятой не
более 2-х
знаков)
Важно: нужно обязательно задать либо cityID, либо cityName, как в случае города
отправления, так и в случае города доставки.
2.5.2. Параметры входного сообщения для getServiceCostByParcels2
Параметр
Внешний тэг request
auth
clientNumber
clientKey
Описание
Тип
Обязательный
Пример
Ваш клиентский
номер в системе
DPD (номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Строка
Да
1000000000
Строка
Да
1FD890C3556
Идентификатор
города отправления
Город отправления
Число
Нет
49694102
Строка
Нет
Москва
(буквенные
обозначения
аббревиатур
и других
знаков)
pickup
cityId
cityName
28
Параметр
regionCode
countryCode
Описание
Код региона
отправления
Код страны
отправления
Тип
Строка
Обязательный
Нет
77
Пример
Строка
Нет
RU
Идентификатор
города доставки
Город доставки
Число
Нет
49265227
Строка
Нет
Код региона
доставки
Код страны доставки
Доставка от
терминала
Доставка до
терминала
Список кодов услуг
DPD. Если параметр
задан, то сервис
возвращает
стоимость только
заданных услуг.
Если он не задан –
всех доступных
услуг.
Предполагаемая
дата приёма груза.
Стоимость будет
считаться на
заданную дату. Если
параметр не задан –
будет считаться на
текущую дату.
Максимально
допустимый срок.
Если параметр
задан, то все услуги
с большим сроком
не будут
показываться.
Параметр не имеет
смысла, если
задавать конкретную
услугу.
Максимально
допустимая
стоимость. Если
параметр задан, то
все услуги с
большей
стоимостью не будут
показываться.
Параметр не имеет
смысла, если
задавать конкретную
услугу.
Строка
Нет
Челябинск
(буквенные
обозначения
аббревиатур
и других
знаков)
74
Строка
boolean
Нет
Да
RU
false
boolean
Да
true
Строка
Нет
BZP, ECN
Дата
Нет
2014-05-21
Целое
число
Нет
2
Число
Нет
1000
delivery
cityId
cityName
regionCode
countryCode
selfPickup
selfDelivery
serviceCode
pickupDate
maxDays
maxCost
29
Список
кодов
услуг
через
запятую
Параметр
declaredValue
Описание
Объявленная
ценность груза
Тип
Число
Обязательный
Нет
parcel
Список посылок с
параметрами для
расчета
parcel
Да
Пример
1000 (после
запятой не
более 2-х
знаков)
2.5.3. Параметры ответа при ошибке
Параметр
Описание
Код ошибки
Сообщение об ошибке
Тип
Строка
Строка
Пример
too-many-rows
Неоднозначно
задан населенный
пункт
cityId
countryCode
countryName
regionCode
regionName
Массив дублирующихся
городов доставки
Идентификатор города
Код страны
Страна
Код региона
Регион
Число
Строка
Строка
Строка
Строка
cityCode
cityName
Код населенного пункта
Населенный пункт
Строка
Строка
abbreviation
indexMin
indexMax
Строка
Строка
Строка
cityId
countryCode
countryName
regionCode
regionName
Аббревиатура
Минимальный индекс
Максимальный индекс
Массив дублирующихся
городов забора
Идентификатор города
Код страны
Страна
Код региона
Регион
195901073
RU
Россия
71
Тульская обл.
(формат ФИАС)
RU71017001000
Новомосковск
(буквенные
обозначения
аббревиатур и
других знаков)
г
301650
301650
cityCode
cityName
Код населенного пункта
Населенный пункт
Строка
Строка
abbreviation
indexMin
indexMax
Аббревиатура
Минимальный индекс
Максимальный индекс
Строка
Строка
Строка
сode
message
deliveryDups
pickupDups
Число
Строка
Строка
Строка
Строка
232636063
RU
Россия
50
Московская обл.
(формат ФИАС)
RU50026000002
Каменка
(буквенные
обозначения
аббревиатур и
других знаков)
д
142167
142167
2.5.4. Параметры ответа при успешном запросе
Параметр
Описание
Тип
serviceСode
serviceName
Код услуги DPD
Название услуги
Строка
Строка
cost
days
Стоимость услуги
Срок доставки, дней
Число
Целое число
30
Пример
ECN
DPD
ECONOMY
2,651.46
2
2.6. Типы
2.6.1. Описание типа parcel
Параметр
weight
length
width
height
quantity
Описание
Вес посылки, см
Длина посылки, см
Ширина посылки, см
Высота посылки, см
Количество посылок
Тип
Число
Число
Число
Число
Число
31
Обязательный
Да
Да
Да
Да
Нет
Пример
0.5
20.0
20.0
20.0
3
Веб-служба «Создание заказа»
3.
3.1. Описание
Веб-служба «Создание заказа» предназначена для создания заказов на доставку в
информационной системе DPD.
3.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/order2?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/order2?wsdl
3.3. Доступные методы
Метод
Назначение
Входящее
сообщение
Параметры
входного
сообщения
CreateOrder
createOrder
Создать заказ на доставку
getOrderStatus
Получить статус создания
заказа
Параметры
входного
сообщения
getOrderStatus
createAddress
Создать адрес с кодом
Параметры
входного
сообщения
updateAddress
Изменить адреса с кодом
Параметры
входного
сообщения
getInvoiceFile
Получить файл накладной
(формат файла – PDF)
Параметры
входного
сообщения
getRegisterFile
Получить реестр заказов,
передаваемых курьеру DPD
(формат файла - xls)
Параметры
входного
сообщения
Ответное
сообщение
Параметры ответа
при ошибке /
Параметры
ответного
сообщения
Параметры ответа
при ошибке /
Параметры
ответного
сообщения
Параметры ответа
при ошибке /
Параметры ответа
при успешном
запросе
Параметры ответа
при ошибке /
Параметры ответа
при успешном
запросе
Параметры ответа
при ошибке/
Параметры ответа
при успешном
запросе
Параметры ответа
при успешном
запросе
3.4. Алгоритмы
3.4.1. Создание заказа на доставку
1. Подготавливаем параметры вызова: массив заказов, объединенных общим адресом
приёма груза и датой приема отправки, в соответствии с описанием входного сообщения
метода createOrder.
2. Вызываем метод createOrder.
3. Получаем ответное сообщение с результатом выполнения функции по каждому заказу.
4. Анализируем статус создания заказа (см. «Статусы создания заказа») и при необходимости
– сообщение об ошибке.
5. Если статус заказа – OrderPending, то через какое-то время можно вызвать метод
getOrderStatus, чтобы убедиться в том, что заказ доработан и создан в информационной
системе DPD.
32
3.4.2. Создание адреса с кодом
1. Подготавливаем параметры вызова в соответствии с описанием входного сообщения
метода createAddress.
2. Вызываем метод createAddress.
3. Получаем ответное сообщение с результатом создания адреса.
4. Анализируем статус создания адреса (см. «Статусы создания и изменения адреса») и при
необходимости – сообщение об ошибке.
5. Если статус адреса - address-error, необходимо внести изменения в параметры и повторно
вызвать метод.
3.4.3. Изменение адреса с кодом
1. Подготавливаем параметры вызова в соответствии с описанием входного сообщения
метода updateAddress.
2. Вызываем метод updateAddress.
3. Получаем ответное сообщение с результатом создания адреса.
4. Анализируем статус создания адреса (см. «Статусы создания и изменения адреса») и при
необходимости – сообщение об ошибке.
a. Если статус адреса - code-not-found – в системе отсутствует адрес с таким кодом,
соответственно для создания адреса необходимо воспользоваться методом
createAddress.
b. Если статус адреса - address-error, необходимо внести изменения в параметры или
добавить недостающие и повторно вызвать метод.
3.5. Сообщения
3.5.1. Параметры входного сообщения createOrder
Внешний
тэг
auth
Параметр
orders
clientNumber
clientKey
header
datePickup
payer
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Информация,
содержащаяся в этом
параметре, является
общей для всех
заказов в запросе
Дата приёма груза
Клиентский номер
плательщика в
системе DPD (номер
договора с DPD).
Если этот параметр
не заполнен, то
плательщиком будет
считаться заказчик
(номер из параметра
auth).
При оплате
наличными
указываются
значения в
33
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Дата
Число
Да
Нет
Параметр
senderAddress
pickupTimePeriod
regularNum
order
orderNumberIntern
al
serviceCode
serviceVariant
cargoNumPack
cargoWeight
cargoVolume
cargoRegistered
Описание
extraParam
Адрес приёма груза
Интервал времени
приёма груза.
Доступные для
выбора интервалы
приёма см. в разделе
«Интервалы времени
приёма».
Номер регулярного
заказа DPD. Если вы
используете доставку
на регулярной
основе, уточните этот
номер у своего
менеджера.
Массив данных,
относящихся к
каждому конкретному
заказу
Номер заказа в
информационной
системе клиента
Код услуги DPD.
Уточните код нужной
Вам услуги у своего
менеджера или
используйте код
услуги, полученный
из веб-сервиса
«Калькулятор
стоимости»
Вариант доставки.
Доступно 4 варианта:
ДД, ДТ, ТД и ТТ.
Расшифровку
вариантов см. в
разделе «Варианты
доставки».
Количество
грузомест (посылок)
в отправке
Вес отправки, кг
Объём, м3
Ценный груз.
Внутреннее
вложение,
включенное в
перечень товаров,
требующих
дополнительных мер
безопасности,
снижающих риск его
утери или
повреждения при
перевозке.
Перечень товаров,
относимых к
категории «Ценный
34
Тип
Обязательный
Пример
address
Строка
Да
Да
9-18
Строка
Нет
1000
Строка
Да
123456
Строка
Да
CUR
Строка
Да
ДД
Целое
число
Да
5
Число
Число
Да
Нет
5
0.05
false
boolean
Да
Параметр
cargoValue
cargoCategory
paymentType
deliveryTimePeriod
extraParam
dataInt
receiverAddress
extraService
parcel
unitLoad
Описание
груз»:
1. Мобильные
телефоны
2. Ноутбуки,
планшеты
Сумма объявленной
ценности, руб.
Содержимое
отправки
Форма оплаты
«Возможные
варианты оплаты»
Интервал времени
доставки груза.
Доступные для
выбора интервалы
доставки см. в
разделе «Интервалы
времени доставки».
Зарезервированный
параметр для ввода
новых параметров
без изменения схемы
сервиса
Данные для
международных
отправок
Адрес доставки
Массив опций
доставки
Массив посылок
отправки
Массив вложений в
посылке
Тип
Обязательный
Пример
Число
Нет
Строка
Да
1000
(после
запятой
не более
2-х
знаков)
Одежда
Строка
Нет
ОУП
Строка
Нет
9-18
parameter
Нет
dataIntern
ational
Нет
address
extraServi
ce
parcel
Да
Нет
unitLoad
нет
Нет
3.5.2. Параметры входного сообщения getOrderStatus
Внешний
тэг
auth
Параметр
orderStatus
clientNumber
clientKey
order
orderNumberIntern
al
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Информация о
заказе, статус
которого вы
проверяете
Номер заказа в
информационной
35
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Строка
Да
123456
Параметр
datePickup
Описание
системе клиента
Дата приёма груза
(на тот случай, если
номер в вашей
информационной
системе не является
уникальным)
Тип
Дата
Обязательный
Пример
Нет
3.5.3. Параметры ответного сообщения createOrder \ getOrdersStatus
Параметр
orderNumberInternal
orderNum
status
errorMessage
Описание
Номер заказа в
информационной
системе клиента
Номер заказа DPD.
Возвращается в
ответном сообщении.
Статус создания
заказа.
Возвращается в
ответном сообщении.
Возможные статусы
перечислены в
разделе «Статусы
создания заказа».
Текст ошибки
Тип
Строка
Обязательный
Да
Пример
123456
Строка
Нет
01010001M
OW
Строка
Да
OK
Строка
Нет
Не
заполнен
параметр
«Улица»
3.5.4. Параметры входного сообщения createAddress \ updateAddress
Параметр
Внешний тэг
address
auth
clientNumber
clientKey
clientAddress
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Адрес
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
address
Да
3.5.5. Параметры ответного сообщения createAddress \ updateAddress
Параметр
code
status
errorMessage
Описание
Код адреса
Статус.
Возможные статусы
описаны в «Ошибки
службы «Создания
адреса с кодом»»
Описание ошибки
36
Тип
Строка
Строка
Обязательный
Да
Да
Пример
X333
addresserror
Строка
Нет
Не указана
улица
3.5.6. Параметры входного сообщения getInvoiceFile
Параметр
Внешний тэг
request
auth
clientNumber
clientKey
orderNum
parcelCount
cargoValue
Описание
Тип
Обязательный
Пример
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Номер заказа DPD
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Строка
Да
Количество мест в
заказе
Сумма объявленной
ценности, руб.
Число
Нет
01010001M
OW
3
Число
Нет
1000
(после
запятой
не более
2-х
знаков)
ПРИМЕЧАНИЕ. Если не заданы parcelCount или cargoValue, то при формировании файла
выводятся параметры из заказа.
3.5.7. Параметры ответного сообщения getInvoiceFile
Параметр
Описание
Файл
file
Тип
Массив
байтов
Обязательный
Да
Пример
3.5.8. Параметры входного сообщения getRegisterFile
Параметр
Внешний тэг
request
auth
clientNumber
clientKey
datePickup
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Дата приёма груза
(на тот случай, если
номер в вашей
информационной
системе не является
уникальным)
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Дата
Да
2014-09-15
3.5.9. Параметры ответного сообщения getRegisterFile
Параметр
file
Описание
Файл
37
Тип
Массив
байтов
Обязательный
Да
Пример
3.5.10. Параметры ответа при ошибке
Параметр
Тип
Строка
Обязательный
Да
Пример
no-datafound
Строка
Нет
Данные не
найдены
Описание
Код адреса в
информационных
системах заказчика и
DPD. Адрес с кодом
должен быть
передан в DPD
отдельно.
Название
отправителя/получате
ля. В случае, когда
адрес приёма/доставки
– это магазин, филиал
компании, дилерский
центр и т.п., в эту
строку пишется его
название. Если
доставка
осуществляется
физическому лицу, то
пишется Ф.И.О
получателя.
Код терминала.
Строка адреса для
международных
отправок
Тип
Строка
Обязательный
Нет
Пример
1234
Строка
Да1
Иванов
Сергей
Петрович
Строка
Строка
Да2
Нет
countryName
index
region
Название страны
Индекс
Регион
Строка
Строка
Строка
Да
Нет
Нет
city
street
Город
Улица (формат
ФИАС)
Сокращения типа
улицы (ул, пр-т, б-р и
т.д.)
Дом
Строка
Строка
Да3
Да3
M91
16, Grafton
Street,
Dublin,
Ireland
Россия
140012
Московска
я обл.
Люберцы
Авиаторов
Строка
Да3
ул
Строка
Да3
1
code
message
Описание
Код ошибки.
Возможные коды
описаны в «Ошибки
службы «создания
заказа»».
Описание ошибки
3.6. Типы
3.6.1. Описание типа address
Параметр
code
name
terminalCode
addressString
streetAbbr
house4
1
Данное поле не является обязательным при условии, что заполнено поле code
Данное поле является обязательным для вариантов перевозки «ДТ», «ТД» или «ТТ» в методе createOrder.
При использовании метода createAddres, данный параметр указывать не нужно.
2
38
Параметр
houseKorpus6
str6
vlad6
extraInfo
Описание
Корпус
Строение
Владение
Доп. Информация
Тип
Строка
Строка
Строка
Строка
Обязательный
Нет
Нет
Нет4
Нет
office
Офис
Строка
Нет
flat
Квартира
Строка
Нет
workTimeFrom
workTimeTo
dinnerTimeFrom
dinnerTimeTo
contactFio
Время работы от
Время работы до
Время обеда от
Время обеда до
Контактное лицо
Строка
Строка
Строка
Строка
Строка
Нет
Нет
Нет
Нет
Да5
contactPhone
Контактный телефон
Строка
Да6
contactEmail
Контактный e-mail
Строка
Нет
instructions
Инструкции для
курьера
Строка
Нет
Тип
Строка
Строка
Обязательный
Нет
Нет
Пример
А
1
1
Пав. 1
(max 90
символов
)
12
(только
цифры
или
цифры с
буквами
12Б)
144
(только
цифры
или
цифры с
буквами
144А)
9:00
21:00
14:00
15:00
Смирнов
Игорь
Николаеви
ч
891655555
55
smirnov@
megashop.
ru
Подъезд
со
стороны
ул. Кирова
3.6.2. Описание типа dataInternational
Параметр
currency
currencyDeclaredValue
3
Описание
Валюта
Объявленная ценность
в валюте
Пример
USD
100 (после
запятой
не более
2-х
знаков)
Данное поле не является обязательным при условии, что заполнено поле code или поле vlad.
4
Данное поле не является обязательным при условии, что заполнено поле code или поле house.
Данное поле не является обязательным при условии, что заполнено поле code
6
Нельзя передавать буквенные значения на английском языке. В поле house нельзя передавать только
буквенное значение, но можно передавать букву после указания номера дома в таком варианте «1Б» или
через «/» в таком варианте «1/Б». Знаки препинания и другие знаки кроме «/» указывать нельзя
5
39
3.6.3. Описание типа extraService
Параметр
Описание
Код опции. См
описания опций в
разделе «Опции».
Параметр опции.
esCode
param
Тип
Строка
Обязательны
й
Да
parameter
Нет
Пример
SMS
3.6.4. Описание типа parameter
Параметр
Описание
Имя параметра
Возможные варианты
параметра
Значение параметра
name
value
Тип
Строка
Обязательны
й
Да
Строка
Да
Пример
phone
891655555
55
3.6.5. Описание типа parcel
Параметр
Описание
Номер посылки в
информационной
системе клиента
(номер штрих-кода
посылки)
Вес посылки
Длина посылки, см
Ширина посылки,см
Высота посылки, см
number
weight
length
width
height
Тип
Строка
Обязательны
й
Да
Число
Число
Число
Число
Нет
Нет
Нет
Нет
Пример
100100099
8
0.5
50.0
20.0
20.0
3.6.6. Описание типа unitLoad
Параметр
Описание
Тип
article
descript
declared_value
Артикул
Номенклатура
Объявленная ценность
Строка
Строка
Число
Обязательны
й
Да
Да
Нет
parcel_num
npp_amount
Посылка клиент
Цена
Строка
Число
Нет
Нет
3.7. Варианты доставки
Доступны следующие варианты:




ДД – от двери отправителя до двери получателя;
ДТ – от двери отправителя до терминала DPD;
ТД – от терминала DPD до двери получателя;
ТТ – от терминала DPD до терминала DPD.
3.8. Интервалы времени приёма
Доступны следующие варианты выбора времени приёма груза:
40
Пример
201
Брюки
100
(после
запятой
не более
2-х
знаков)
parcel_1
100



9-18 – в любое время с 09:00 до 18:00 (вариант по умолчанию);
9-13 – с 09:00 до 13:00;
13-18 – с 13:00 до 18:00.
3.9. Интервалы времени доставки
Доступны следующие варианты выбора времени доставки груза:





9-18 – в любое время с 09:00 до 18:00 (вариант по умолчанию);
9-14 – с 09:00 до 14:00;
13-18 – с 13:00 до 18:00;
18-22 – с 18:00 до 22:00. (внимание, данный интервал оплачивается дополнительно!)
9-22 – с 09:00 до 22:00. (внимание, данный интервал работает только по услугам DPD
Consumer, DPD Classic Parcel ,DPD Classic international)
3.10.


ОУП – оплата у получателя
ОУО – оплата у отправителя
3.11.
Код
услуг
BZP
ECN
TEN
DPT
CUR
NDY
CSM
PCL
DPI
3.12.
Код опции
SMS
EML
ЭСД
ЭСЗ
ВДО
Варианты формы оплаты
Услуги DPD
Наименование
DPD 18:00
DPD ECONOMY
DPD 10:00
DPD 13:00
DPD CLASSIC
DPD EXPRESS
DPD CONSUMER
DPD CLASSIC Parcel
DPD Classic international
Опции
SMS уведомление
получателя о приёме
посылки у отправителя и о
выходе посылки на доставку
E-mail уведомление
получателя о приёме
посылки у отправителя и о
выходе посылки на доставку
Электронное сообщение о
доставке груза получателю
Нет
Имя параметра для
передачи
сопутствующих
данных
phone
Нет
email
Нет
email
Электронное сообщение о
приёме заказа
Нет
email
Возврат документов
отправителю.
Да
-
Описание опции
Опция
платная
41
Значение
параметра
Телефон
получателя для
отправки
уведомления
E-mail получателя
для отправки
уведомления
E-mail, на который
нужно отправить
сообщение о
доставке груза
E-mail, на который
нужно отправить
сообщение о
приёме заказа
Код опции
ДВД
НПП
Описание опции
Если клиенту необходимо
вернуть сопроводительные
документы на груз (товарную
накладную, акты приемапередачи), заверенные
получателем.
Доставка в выходные дни.
Эта опция, позволяющая
осуществить доставку
отправки получателю в
соответствии со сроком
доставки ТК, но раньше
даты, рассчитанной по
стандартным правилам, при
условии, что итоговая дата
доставки придется на
выходной день.
Наложенный платеж
Опция
платная
Имя параметра для
передачи
сопутствующих
данных
Да
-
Да
sum_npp
cумма наложенного
платежа1
Подтверждение о доставке
Да
email/fax
E-mail или факс, на
который нужно
отправить
подтверждение о
доставке
Погрузо-разгрузочные
работы при доставке.
Если необходимо
организовать разгрузку и
доставку поступивших
посылок в то или иное
помещение на территории,
независимо от того, на каком
этаже оно расположено.
Температурный режим
Да
-
Да
-
Ожидание на адресе
Да
reason_delay
ПОД
ПРД
ТРМ
Значение
параметра
причина ожидания
на адресе из
Справочника
причин ожидания
на адресе:
ВНЕШ Проверка на
внешние
повреждения
ПРИМ Примерка
РАБТ Проверка
работоспособности
СООТ Проверка на
соответствие
ОЖД
42
Код опции
Опция
платная
Описание опции
Возврат части отправки
Да
Имя параметра для
передачи
сопутствующих
данных
goods_return_amount
Значение
параметра
Компенсация
доставки при
полном возврате
ЧСТ2
Компенсация
доставки
delivery_amount
1.
2.
Указывать обязательно, при условии, что сумма за Наложенный платеж будет отличаться от суммы
Объявленной стоимости.
- если с получателя нужно взимать стоимость доставки только при отказе от всего товара, то данная
стоимость передается в параметре «Компенсация доставки при полном возврате», а в параметре
«Компенсация доставки» не передается ничего

данный вариант не может использоваться совместно со способом оплаты услуг DPD
«Наличными получателем»;
- если с получателя всегда нужно взимать стоимость доставки, то данная стоимость передается в
параметре «Компенсация доставки», а в параметре «Компенсация доставки при полном возврате»
не передается ничего

данный вариант не может использоваться совместно со способом оплаты услуг DPD
«Наличными получателем»;
- если с получателя не нужно взимать стоимость доставки, то информация не передается ни в
параметре «Компенсация доставки при полном возврате», ни в параметре «Компенсация доставки».
3.12. Справочник параметров
3.12.1. Справочник формы оплаты.
Название параметра name
Вариант формы оплаты услуги и
плательщика
Значение - value
Оплата наличными отправителем на
терминале отправки
плательщик – юридическое лицо
Оплата наличными получателем на
терминале доставки
плательщик – юридическое лицо
Оплата наличными получателем у двери
плательщик – юридическое лицо
order_payment_type
payer_num
Оплата наличными отправителем на
терминале отправки
плательщик – физическое лицо
order_payment_type
payer_num
Оплата наличными получателем на
терминале доставки
плательщик – физическое лицо
order_payment_type
payer_num
‘ОУП’
‘1001028502’номер
для оплаты наличными
Оплата наличными получателем у двери
плательщик – физическое лицо
order_payment_type
payer_num
‘ОУП’
‘1001028502’номер
для оплаты наличными
order_payment_type
payer_num
order_payment_type
payer_num
‘ОУО’
десятизначный номер
клиента плательщика
‘ОУП’
десятизначный номер
клиента плательщика
‘ОУП’
десятизначный номер
клиента плательщика
‘ОУО’
‘1001028502’номер
для оплаты наличными
3.12.2. Справочник для создания пропуска.
Название параметра name
Описание параметра
Пропуск
требуется
отправителя
при
заборе
у
pickup_need_pass
43
Значение - value
1
Пропуск требуется
получателю
3.13.
при
доставке
к
delivery_need_pass
1
Статусы создания заказа
В ответном сообщении о создании заказа может быть возвращен один из следующих статусов:
 OK – заказ на доставку успешно создан с номером, указанным в поле orderNum.
 OrderPending – заказ на доставку принят, но нуждается в ручной доработке сотрудником
DPD, (например, по причине того, что адрес доставки не распознан автоматически). Номер
заказа будет присвоен ему, когда это доработка будет произведена.
 OrderDuplicate – заказ на доставку не может быть принять по причине, указанной в поле
errorMessage.
 OrderError – заказ на доставку не может быть создан по причине, указанной в поле
errorMessage.
3.14.
Статусы создания и изменения адреса
В ответном сообщении о результатах создания адреса может быть возвращен один из следующих
статусов:
 ОК – адрес с кодом создан.
 code-already-exists – адрес с указанным кодом уже существует.
 address-error – адрес не может быть создан. Причина при этом указывается в поле
message.
 code-not-found- адрес с указанным кодом не найден.
44
4.Веб-служба «Изменение заказа»
4.1. Описание
Веб-служба «Изменение заказа» предназначена для внесения изменений в уже созданный
заказ на доставку в информационной системе DPD. При этом внесение изменений в заказ
возможно до физического получения груза на терминале DPD.
4.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/order2?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/order2?wsdl
4.3. Доступные методы
Метод
Назначение
addParcels
Изменить заказ с
добавлением посылок
removeParcels
Изменить заказ с удалением
посылок
Входящее
сообщение
Параметры
входного
сообщения
addParcels
Параметры
входного
сообщения
removeParcels
Ответное
сообщение
Параметры
ответного
сообщения
Параметры
ответного
сообщения
4.4. Алгоритмы
4.4.1. Изменение заказа с добавлением посылок
1. Подготавливаем параметры вызова: массив данных изменяемых заказов и список
добавляемых посылок в соответствии с описанием входного сообщения метода
addParcels.
2. Вызываем метод addParcels.
3. Получаем ответное сообщение с результатом выполнения функции по каждому заказу.
4.4.2. Изменение заказа с удалением посылок
1. Подготавливаем параметры вызова: массив данных изменяемых заказов и список
удаляемых посылок в соответствии с описанием входного сообщения метода
removeParcels.
2. Вызываем метод removeParcels.
3. Получаем ответное сообщение с результатом выполнения функции по каждому заказу.
4.5. Сообщения
4.5.1. Параметры входного сообщения addParcels \ removeParcels
Параметр
Внешний тэг
parcels
auth
clientNumber
clientKey
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
45
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Параметр
orderNum
orderNumberI
nternal
cargoNumPac
k
cargoWeight
cargoVolume
cargoValue
cargoCategory
parcel
Описание
авторизации,
полученный у
сотрудника DPD
Номер заказа
Тип
Обязательный
Пример
Строка
Да
Номер заказа в
информационной
системе клиента
Количество
грузомест (посылок)
в отправке
Вес отправки, кг
Объём, м3
Сумма объявленной
ценности, руб.
Строка
Нет
01010001M
OW
123456
Целое
число
Да
5
Число
Число
Число
Да
Нет
Нет
Содержимое
отправки
Посылки для
добавления в заказ
Строка
Да
5
0.05
1000
(после
запятой
не более
2-х
знаков)
Одежда
parcel
4.5.2. Параметры ответного сообщения для addParcels \ removeParcels
Параметр
orderNum
status
parcelStatus
Описание
Номер заказа DPD.
Возвращается в ответном
сообщении.
Статус изменения заказа.
Возвращается в ответном
сообщении. Возможные
статусы перечислены в
разделе «Статусы
изменения заказа»
Список посылок
Тип
Строка
Обязательный
Нет
Пример
01010001M
OW
Строка
Да
OK
parcelStatus
Нет
Тип
Строка
Обязательный
Да
Пример
WS121
Число
Число
Число
Число
Нет
Нет
Нет
Нет
0.5
0.5
0.2
0.2
Тип
Строка
Строка
Обязательный
Да
Да
Пример
WS121
OK
4.6. Типы
4.6.1. Описание типа parcel
Параметр
number
weight
length
width
height
Описание
Номер посылки в
информационной системе
клиента (номер штрих-кода
посылки)
Вес посылки
Длина посылки
Ширина посылки
Высота посылки
4.6.2. Описание типа parcelStatus
Параметр
number
status
Описание
Номер посылки
Статус выполнения
операции. Возможные
46
Параметр
Описание
статусы перечислены в
разделе «Статусы
добавления \ удаления
посылки».
Тип
Обязательный
Пример
4.7. Статусы
4.7.1. Статусы изменения заказа
В ответном сообщении об изменении заказа может быть возвращен один из следующих статусов:



OK – заказ успешно изменен.
illegal-state -состояние заказа не позволяет выполнять его корректировку.
no-data-found – не найдены данные.
4.7.2. Статусы добавления \ удаления посылки
В ответном сообщении об изменении состава посылок в заказе может быть возвращен один из
следующих статусов:



no-data-found - при удалении посылка с указанным номером в заказе не найдена.
too-many-rows - при удалении найдено более одной посылки с указанным номером.
illegal-state - состояние заказа не позволяет выполнять добавление или удаление посылки.
47
5. Веб-служба «Отслеживание статуса»
5.1. Описание
Веб-служба «Отслеживание статуса» предоставляет сервис для отслеживания состояния посылок
клиента DPD. Можно отслеживать изменения всех статусов посылок своего клиентского номера,
либо запрашивать историю состояний по конкретному заказу или посылке.
Для использования данной веб – службы Вам необходимо обратиться в it_customers и
запросить одну из настроек – «с подтверждением» или «без подтверждения».
5.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru:80/services/tracing?wsdl
http://wstest.dpd.ru:80/services/tracing1-1?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru:80/services/tracing?wsdl
http://ws.dpd.ru:80/services/tracing1-1?wsdl
Доступные методы:
tracing?wsdl – confirm, getStatesByClient, getStatesByClientOrder, getStatesByClientParcel,
getStatesByDPDOrder.
tracing1-1?wsdl – getStatesByClientOrder, getStatesByClientParcel, getStatesByDPDOrder
5.3. Доступные методы
Метод
getStatesByClient
confirm
getStatesByClientOrder
getStatesByClientParcel
getStatesByDPDOrder
Назначение
Получить все состояния
посылок клиента,
изменившиеся с момента
последнего вызова данного
метода
Подтвердить получение
состояний, переданных
методом getStatesByClient
Получить историю состояний
всех посылок заданного
заказа. Заказ
идентифицируется по
номеру заказа в
информационной системе
клиента.
Получить историю состояний
заданной посылки. Посылка
идентифицируется по
номеру посылки в
информационной системе
клиента.
Получить историю состояний
всех посылок заданного
заказа. Заказ
идентифицируется по
номеру заказа в
информационной системе
DPD.
48
Входящее
сообщение
getStatesByClient
Исходящее
сообщение
getStatesByClientR
esponse
confirm
confirmResponse
getStatesByClientOr
der
getStatesByClientO
rderResponse
getStatesByClientPar
cel
getStatesByClientP
arcelResponse
getStatesByDPDOrd
er
getStatesByDPDOr
derResponse
5.4. Алгоритмы
5.4.1. Алгоритм работы с методом getStatesByClient
С методом getStatesByClient можно работать двумя способами: с подтверждением и без
подтверждения. Вам необходимо сообщить желаемый метод сотруднику DPD при подключении
сервиса. По умолчанию используется метод работы с подтверждением.
Если вы работаете с подтверждением, то метод getStatesByClient не выдаст вам новых
состояний, пока не получит от вас подтверждения прочтения переданных состояний через метод
confirm. Если наша система не получит такого подтверждения, то при следующем запросе она
выдаст те же состояния, что и в предыдущем. Таким образом, гарантируется защита от сбоя при
передаче данных - если сбой произошел, данные не потеряются, а будут переданы при повторном
запросе. Вызов метода confirm говорит нам о том, что процесс передачи данных прошел успешно,
и все данные закачаны в информационную систему клиента.
Если вы работаете без подтверждения, то метод getStatesByClient будет всегда выдавать только
новые состояния. При формировании новой порции состояний система учитывает только то, были
ли состояния уже переданы через веб-сервис и не принимает в расчёт то, были ли они загружены
в систему клиента.
Вы также можете воспользоваться настройкой «Расширенное отслеживание». С помощью
данной настройки Вы сможете в отслеживании видеть код и наименование инцидента с посылкой.
Алгоритм работы:
1. Подготавливаем параметры аутентификации.
2. Вызываем метод getStatesByClient.
3. Получаем ответное сообщение с идентификатором документа и массивом состояний
посылок.
4. Если выбран способ работы с подтверждением - вызываем метод confirm, передавая в
качестве параметра полученный идентификатор документа.
5.4.2. Алгоритм работы с методами getStatesByClientOrder,
getStatesByDPDOrder, getStatesByClientParcel
Данные методы позволяют получить полную историю состояний нужного заказа или посылки. По
запрошенному заказу или посылке передаются все состояния, независимо от того, были ли они
уже переданы или нет. Никаких подтверждений не требуется.
Алгоритм работы:
1. Подготавливаем параметры аутентификации и номер для идентификации заказа или
посылки.
2. Вызываем нужный метод.
3. Получаем ответное сообщение с массивом состояний посылок.
4. Чтобы узнать текущее состояние посылки, выбираем последнее по параметру
transitionTime.
a. Входящие сообщения
5.4.3. getStatesByClient
Параметр
Внешний request
тэг
auth
clientNumber
Описание
Тип
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
49
Число
Обязательный
Да
Пример
1000000000
Параметр
clientKey
Описание
Ваш уникальный ключ
для авторизации,
полученный у сотрудника
DPD
Тип
Строка
Обязательный
Да
Пример
1FD890C3556
5.4.4. confirm
Параметр
Внешний request
тэг
auth
clientNumber
clientKey
docId
Описание
Тип
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ для
авторизации, полученный у
сотрудника DPD
Идентификатор документа,
полученного в запросе
getStatesByClient. Все
сообщения, переданные по
данному документу,
получат статус «Получение
подтверждено».
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Число
Да
12346897
5.4.5. getStatesByClientOrder
Параметр
Внешний request
тэг
auth
clientNumber
clientKey
clientOrderNr
pickupDate
Описание
Тип
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ
для авторизации,
полученный у сотрудника
DPD
Номер заказа в
информационной системе
клиента
Дата приёма груза (на
случай, если номер
заказа не уникален, и
требуется уточнение по
дате)
Обязательный
Пример
Число
Да
1000000000
Строка
Да
1FD890C3556
Строка
Да
12346DPD
Дата
Нет
2014-02-28
5.4.6. getStatesByClientParcel
Параметр
Внешний request
тэг
auth
clientNumber
clientKey
clientParcelNr
Описание
Тип
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ
для авторизации,
полученный у сотрудника
DPD
Номер посылки в
50
Обязательный
Пример
Число
Да
1000000000
Строка
Да
1FD890C3556
Строка
Да
12346897
Параметр
pickupDate
Описание
информационной системе
клиента
Дата приёма груза (на
случай, если номер
посылки не уникален, и
требуется уточнение по
дате)
Тип
Дата
Обязательный
Нет
Пример
2014-02-28
5.4.7. getStatesByDPDOrder
Внешний
тэг
auth
Параметр
request
clientNumber
clientKey
dpdOrderNr
pickupYear
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Номер заказа в
информационной
системе DPD
Год заказа (т.к.
номера заказов DPD
уникальные в
пределах года,
требуется уточнение,
чтобы получить
однозначный
результат)
Тип
Обязательный
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Строка
Да
04040001M
OW
Целое
число
Нет
2012
5.5. Исходящие сообщения
5.5.1. getStatesByClientResponse
Параметр
docId
docDate
clientNumber
resultComplete
states
clientOrderNr
Описание
Идентификатор документа.
Данный идентификатор
используется для
подтверждения получения
статусов
Дата формирования
документа
Ваш клиентский номер в
системе DPD
Показывает, выбраны ли в
текущем запросе все новые
состояния по клиенту
(значение true), или был
достигнут лимит записей в
одном запросе и для
продолжения необходим ещё
один запрос (значение false).
Массив состояний посылок
Номер заказа в
51
Пример
Тип
Число
Пример
12346897
Дата
2014-02-28
Число
1000000000
boolean
true
Строка
12346DPD
Параметр
Строка
04040001MOW
Строка
12346897
Дата
Строка
2014-02-28
04040002MOW
Строка
12346899
Дата
2014-03-01
Число
2.08
Объем (м3) отправки
Объемный вес (кг.)отправки
Число
Число
0.023
4.6
Платный вес (кг.) отправки
Число
5
Объявленная ценность
Число
Физический вес (кг.)
Число
1200 (после
запятой не
более 2-х
знаков)
1.5
Объем (м3)
Объемный вес (кг.) посылки
Число
Число
0.008
1.5
Платный вес (кг.) посылки
Число
1.5
Число
Число
Число
Строка
157
7
7
Delivering
transitionTime
Длина (см.) посылки
Ширина (см.) посылки
Высота (см.) посылки
Состояние посылки после
перехода. См. список
возможных состояний в
разделе «Состояния» пункт
«Посылка».
Время перехода состояния
terminalCode
Код терминала DPD, на
Дата/врем
я
Строка
2012-0404T17:10:15
LED
dpdParcelNr
pickupDate
dpdOrderReNr
dpdParcelReNr
*
*
*
*
*
*
*
*
*
Пример
12346897
dpdOrderNr
*
*
Тип
Строка
clientParcelNr
*
Описание
информационной системе
клиента
Номер посылки в
информационной системе
клиента
Номер заказа в
информационной системе
DPD
Номер посылки в
информационной системе
DPD
Дата приёма груза
Номер повторного заказа в
системе DPD (заполняется в
том случае, если по одному и
тому же клиентскому номеру
посылки в системе DPD
существует два заказа –
например, при заказе на
возврат посылки)
Номер посылки при повторном
заказе в системе DPD
(заполняется в том случае,
если по одному и тому же
клиентскому номеру посылки в
системе DPD существует два
заказа – например, при заказе
на возврат посылки)
Планируемая дата доставки
посылки
Физический вес (кг) отправки
planDeliveryDat
e
orderPhysicalW
eight
orderVolume
orderVolumeW
eight
orderPayWeigh
t
orderCost
parcelPhysical
Weight
parcelVolume
parcelVolumeW
eight
parcelPayWeig
ht
parcelLength
parcelWidth
parcelHeight
newState
52
Параметр
terminalCity
incidentCode
incidentName
consignee
Описание
котором произошел переход
состояния
Город терминала DPD, на
котором произошел переход
состояния
Код инцидента,
произошедшего при переходе
состояния. Список возможных
кодов инцидентов и их
расшифровок вы можете
получить у своего менеджера.
Наименование инцидента,
произошедшего при переходе
состояния
Фактический получатель
посылки (передается только
со статусом Delivered)
Тип
Пример
Строка
LED
Строка
90
Строка
Возвращено
отправителю
Строка
Иванов И.И.
* получение данной информации возможно по URL http://wstest.dpd.ru:80/services/tracing1-1?xsd=1
или http://ws.dpd.ru:80/services/tracing1-1?xsd=1
5.5.2. confirmResponse
Структура сообщения аналогична входящему «confirm».
5.5.3. getStatesByClientOrderResponse
Параметры сообщения совпадают с параметрами ответного сообщения
«getStatesByClientResponse».
5.5.4. getStatesByClientParcelResponse
Параметры сообщения совпадают с параметрами ответного сообщения
«getStatesByClientResponse».
5.5.5.getStatesByDPDOrderResponse
Параметры сообщения совпадают с параметрами ответного сообщения
«getStatesByClientResponse».
5.6. Состояния
5.6.1. Посылка
Посылка может принимать одно из следующих состояний:












NewOrderByClient – оформлен новый заказ по инициативе клиента
NotDone– заказ отменен
OnTerminalPickup– посылка находится на терминале приема отправления
OnRoad– посылка находится в пути (внутренняя перевозка DPD)
OnTerminal– посылка находится на транзитном терминале
OnTerminalDelivery– посылка находится на терминале доставки
Delivering – посылка выведена на доставку
Delivered – посылка доставлена получателю
Lost – посылка утеряна
Problem– с посылкой возникла проблемная ситуация
ReturnedFromDelivery– посылка возвращена с доставки
NewOrderByDPD – оформлен новый заказ по инициативе DPD
53
Последовательное отслеживание посылки по статусам становится возможным, когда на
стороне DPD посылка будет обработана на терминале приема. Данной ситуации соответствует
статус «OnTerminalPickup».
В случае если обращение к сервису поступает до момента обработки посылки на стороне DPD
на терминале приема, сервис вернет ошибку с кодом «no-data-found» (см. справочник ошибок)
54
6. Веб-служба «Отчеты»
6.1. Описание
Веб-служба «Отчеты» предоставляет возможность получать отчеты из информационной системы
компании.
6.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/nl?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/nl?wsdl
6.3. Доступные методы
Метод
Назначение
Отчет о предварительной
стоимости перевозки за
указный период.
Отчет об окончательной
стоимости перевозки за
указный период.
getNLAmount
getNLInvoice
Входящее
сообщение
Параметры
входного
сообщения
Параметры
входного
сообщения
Ответное
сообщение
Параметры
ответного
сообщения
Параметры
ответного
сообщения
6.4. Алгоритмы
6.5. Сообщения
6.5.1. Параметры входного сообщения метода
Внешний
тэг
auth
Параметр
arg0
clientNumber
clientKey
dateFrom
dateTo
Описание
Ваш клиентский
номер в системе DPD
(номер вашего
договора с DPD)
Ваш уникальный
ключ для
авторизации,
полученный у
сотрудника DPD
Начальная дата
периода отчета
Конечная дата
периода отчета
Тип
Обязательный
Пример
Число
Да
100000000
0
Строка
Да
1FD890C3
556
Дата
Да
2014-05-21
Дата
Да
2014-05-21
6.5.2. Параметры ответного сообщения метода getNLAmount
Параметр
amount
ordernum
Описание
Стоимость перевозки
Номер заказа
55
Тип
Число
Строка
Обязательный
Нет
Нет
Пример
100
6.5.3. Параметры ответного сообщения метода getNLInvoice
Параметр
amount
invoicenum
ordernum
Описание
Сумма счета
Номер счета
Номер заказа
Тип
Число
Строка
Строка
Обязательный
Нет
Нет
Нет
Пример
100
02200119M
OW
6.6. Ограничение на частоту вызовов
 не разрешается вызывать метод, если еще не завершился предыдущий вызов;
 не разрешается вызывать метод менее чем через 30 минут после предыдущего вызова.
В случае нарушений возвращается ошибка с соответствующим сообщением.
56
7. Веб-служба «Печать Наклейки»
7.1. Описание
Веб-служба «Печать Наклейки» предоставляет сервис для формирования наклейки DPD по
ранее созданному заказу.
7.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/label-print?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/label-print?wsdl
7.3. Доступные методы
Метод
Назначение
createLabelFile
Формирует файл с наклейками
DPD.
Входящее
сообщение
createLabelFile
Ответное сообщение
createLabelFileResponse
7.4. Алгоритмы
Перед вызовом метода в ИС DPD заказы должны быть сформированы, им присвоены
номера DPD (например, 05120002MOW). Далее необходимо в метод передать список номеров
заказов DPD и для каждого заказа количество необходимых наклеек (как правило, оно равно
количеству мест в заказе). В ответ сервис вернет файл с наклейками DPD.
7.4.1. Формат файла
Возвращаемый файл имеет один из двух форматов, который задается во входящем
сообщении:
- PDF;
- FP3 – формат генератора отчетов FastReport.
7.4.2. Формат области печати
Размер наклейки – A6 (четвертушка стандартного листа A4). Возвращаемый файл
формируется в одном из двух вариантов расположения наклеек на листах бумаги: в одну колонку
(для узких принтеров) и две наклейки на ширине листа. Входящее сообщение содержит
строковое поле Формат области печати, которое может содержать значения:
- A6 – в одну колонку;
- A5 – в две колонки.
Примечание. Если задан формат A5, то для каждого заказа первая наклейка печатается в левой
части листа. То есть, если заказы включают по одной посылке, то наклейки разместятся в одну
колонку.
7.5. Входящие сообщения
7.5.1. createLabelFile
Параметр
Внешний
тэг
Auth
Описание
Тип
Обязател
ьный
Пример
getLabelFile
clientNumber
Ваш клиентский номер в
57
Число
Да
1000000000
Параметр
clientKey
fileFormat
pageSize
order
orderNum
parcelsNumber
Описание
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ
для авторизации,
полученный у
сотрудника DPD
Формат файла.
Возможные значения:
PDF, FP3
Формат области печати.
Возможные значения:
A5, A6.
Массив данных,
относящихся к каждому
конкретному заказу
Номер заказа DPD
Кол-во наклеек для
формирования
Тип
Обязател
ьный
Пример
Строка
Да
1FD890C3556
Срока
Да
PDF
Да
A5
Да
Да
05120002MOW
3
Строка
Число
7.6. Исходящие сообщения
7.6.1. createLabelFileResponse
Параметр
Описание
file
Файл
order
Массив данных,
относящихся к каждому
конкретному заказу
Номер заказа DPD
Статус
Сообщение об ошибке
orderNum
status
errorMessage
Тип
Обязател
ьный
Пример
Массив
байтов
58
Строка
Строка
Строка
05120002MOW
OrderPending
Не заполнен
параметр
«Улица»
8. Веб-служба «Отмена заказа»
Описание
8.1.
Веб-служба «Отмена заказа» предоставляет клиентам сервис, который позволяет без звонка в
call-центр DPD:


Отменять оформленные заказы
Инициировать возврат груза, уже переданного курьеру
Расположение
8.2.
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/services/order2?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/order2?wsdl
Доступные методы
8.3.
Метод
cancelOrder
Назначение
Отмена заказа. Создание заказа
на возврат
Входящее
сообщение
Входящие
сообщения
Ответное сообщение
Исходящие сообщения
Алгоритмы
8.4.
Перед вызовом метода в ИС DPD должна быть зарегистрирована заявка на ввод заказа
или заказы должны быть сформированы, им присвоены номера DPD (например, 05120002MOW).
Заказ не должен иметь признака «возврат». Заявка на ввод заказа считается разовым заказом,
если нет номера регулярного заказ, иначе – фактическим регулярным заказом. Далее необходимо
в метод передать список номеров заказов из системы клиента; дату приема заказа (не
обязательно); номер клиента.
Условие успешной отмены заказа – не забранный груз. Условие успешного оформления
возврата отправления – груз забран и нет незавершенного звонка в Call-центр.
Далее система вернет статус результата операции «отмена заказа».
Входящие сообщения
8.5.
Параметр
Внешний
тэг
Auth
Описание
Тип
Обязател
ьный
Пример
orders
clientNumber
clientKey
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ
для авторизации,
полученный у
сотрудника DPD
Число
Да
1000000000
Строка
Да
1FD890C3556
Номер заказа в
информационной
системе клиента
Номер заказа DPD
Дата приема груза
Строка
Да*
123456
Строка
Дата
Да*
Нет
05120002MOW
2014-12-05
cancel
orderNumberInt
ernal
orderNum
pickupdate
59
*Обязательно должен быть указан один из параметров «Номер заказа клиента» или «Номер
заказа DPD»
8.6.
Параметры ответного сообщения
Параметр
orderNumberInternal
Описание
Список посылок
Тип
Строка
Обязательный
Нет
orderNum
Номер заказа DPD.
Возвращается в
ответном сообщении.
Статус изменения
заказа. Возвращается в
ответном сообщении.
Возможные статусы
перечислены в разделе
«Статусы»
Текст сообщения об
ошибке
Строка
Нет
01010001MOW
Строка
Да
Cancelled
status
errorMassage
8.7.
Строка
Статусы
Код Status
Описание
Cancelled
Операция выполнена успешно
CancelledPreviously
Отменено ранее
Error
Текст сообщения об ошибке
8.8.
Текст сообщений об ошибке
Отмена заказа невозможна, возникла ошибка: <Описание проблемы>
Описание проблемы:



Получены не все данные на вход
Полученные данные некорректны
Не найден заказ \ заявка \ отправка
60
Пример
9. Веб-служба «Справочная информация»
Описание
9.1.
Веб-служба «Справочная информация» предоставляет клиентам различную справочную
информацию
Расположение
9.2.
Тестовая версия сервиса доступна по адресу:
http://mowwww101:80/services/inquiry-desk?wsdl
Промышленная версия сервиса доступна по адресу:
http://ws.dpd.ru/services/inquiry-desk?wsdl
Доступные методы
9.3.
Метод
Назначение
Определение клиентского
номера в системе DPD по ИНН
getClientNumByINN
Исходящие сообщения

Подготавливаем данные для аутентификации входного запроса и вызываем
нужный метод.

Получаем ответное сообщение или сообщение об ошибке
Входящее сообщения
9.5.
Параметр
Внешний
тэг
Auth
Описание
Тип
Обязател
ьный
Пример
request
clientNumber
clientKey
clientINN
Ваш клиентский номер в
системе DPD (номер
вашего договора с DPD)
Ваш уникальный ключ
для авторизации,
полученный у
сотрудника DPD
ИНН компании, чей
клиентский номер
необходимо определить
Число
Да
1000000000
Строка
Да
1FD890C3556
Число
Да
1234567890
Параметры ответного сообщения
Параметр
clientINN
clientNumber
status
Ответное сообщение
Алгоритмы
9.4.
9.6.
Входящее
сообщение
Входящие
сообщения
Описание
ИНН компании, чей
клиентский номер
необходимо определить
Номер в системе DPD,
определенный по ИНН
Статус определения
клиентского номера.
Возможные статусы
перечислены в разделе
«Статусы»
61
Тип
Число
Обязательный
Да
Пример
1234567890
Число
Да
1000000000
Строка
Да
ОК
Параметр
errorMassage
Описание
Текст сообщения об
ошибке в зависимости от
статуса
Тип
Строка
Обязательный
Пример
Статусы
9.7.
Код Status
ОК
Описание
Определение клиентского номера по ИНН завершено
успешно
no-data-found
В системе DPD не существует клиентского номера,
зарегистрированного с искомым ИНН
too-many-rows
По заданному ИНН в системе DPD существует несколько
клиентских номеров, зарегистрированных с искомым
ИНН. Просьба обратиться в DPD
no-setting
Нет разрешения на оплату не заказчиком перевозки.
Просьба обратиться к Вашему менеджеру в DPD
10. Веб-служба «Предикт»
10.1. Описание
Интерфейс «Предикт» предназначен для обеспечения возможности пользователям изменять
следующие данные заказа:



Дата доставки в пределах 14 дней со дня поступления заказа на терминал;
Временной интервал доставки (время приезда курьера);
Адрес доставки в пределах города (в том числе можно выбрать «Самовывоз»),
а так же произвести отказ от доставки заказа.
Обмен данными производится в JSON структуре в кодировке UTF-8 , используется архитектура
REST.
10.2. Расположение
Тестовая версия сервиса доступна по адресу:
http://wstest.dpd.ru/rest/application.wadl
http://wstest.dpd.ru/rest/application.wadl/xsd0.xsd
Промышленная версия сервиса доступна по адресу:
http://wst.dpd.ru/rest/application.wadl
http://ws.dpd.ru/rest/application.wadl/xsd0.xsd
10.3. Доступные методы
Параметры всех web методов передаются по методу POST
№ п/п
1
Метод
getShipmentList
Назначение
Входные параметры
Получить список заказов
по заданным параметрам.
Авторизация
62
Входящее сообщение
метода
getShipmentList
Ответные
параметры
Параметры ответного
сообщения
getShipmentList
2
IsAddressChangeable
Получить признак
доступности адреса к
изменению
Входящее сообщение
3
getDeliveryDate
Получить планируемую
дату доставки по заказу
Входящее сообщение
4
getDeliveryIntervalList
Входящее сообщение
5
getAddress
Получить список
интервалов доставки, на
которые можно поменять
интервал доставки из
заказа
Получить адрес доставки
из заказа
6
getStreetList
Получить список улиц из
города доставки
Входящее сообщение
7
getParcelShopList
Получить список пунктов
выдачи, которые можно
выбрать при самовывозе
Входящее сообщение
8
saveDeliveryDate
Подтверждение
изменения планируемой
даты доставки
Входящее сообщение
9
getWebSite
Входящее сообщение
10
cancelOrder
Получение списка ссылок
на страницы dpd.ru с
описанием выбранного
пункта выдачи из списка
Подтверждение отказа от
получения заказа
11
saveAddress
Подтверждение
изменения адреса
доставки
Входящее сообщение
12
getDeliveryDateList
Получить список дат, на
которые можно поменять
планируемую дату
доставки
Входящее сообщение
Входящее сообщение
Входящее сообщение
Параметры ответного
сообщения
IsAddressChangeabl
e
Параметры ответного
сообщения
getDeliveryDate
Параметры ответного
сообщения
getDeliveryIntervalLi
st
Параметры ответного
сообщения
getAddress
Параметры ответного
сообщения
getStreetList
Параметры ответного
сообщения
getParselShopList
Параметры ответного
сообщения
saveDeliveryDate
Параметры ответного
сообщения
getWebSite
Параметры ответного
сообщения
cancelOrder
Параметры ответного
сообщения
saveAddress
Параметры ответного
сообщения
getDeliveryDateList
10.4. Алгоритмы

Подготавливаем данные для аутентификации входного запроса и вызываем
нужный метод.

Получаем ответное сообщение или сообщение об ошибке
10.5. Входящее сообщение метода getShipmentList
Параметр
Описание
Тип
Обяза
тельн
ый
Пример
request
Auth
clientNumber
Клиентский номер
мобильного приложения
Число
Да
3355779903
clientKey
Ключ доступа мобильного
Строка
Да
7BC65C96D4DE98C
63
Параметр
Описание
Тип
Обяза
тельн
ый
приложения
D17072C88BFE21C
C703A38607
Номе заказа в ИнтернетМагазине (Номер заказа в
ИС клиента)
Номер телефона
получателя и/или номер
телефона для SMS
оповещения
Номер заказа DPD.
Возвращается в ответном
сообщении.
eshopOrder
Num
phone
orderNum
Пример
Строка
Нет
1234567890
Строка
Нет
89260161212
Строка
Нет
05120002MOW
10.6. Параметры ответного сообщения getShipmentList
Параметр
Описание
Тип
Обязательный
Пример
sessionId
Параметры заказа
shipment
Тип shipment
Тип shipment
Параметр
Идентификатор заказа в
системе DPD
Номер заказа DPD
Число
Обязател
ьный
Да
Строка
Да
05120002MOW
Строка
Да
Н15в
parcelCount
Номер заказа интернетмагазина
Число посылок
Целое число
Да
1
deliveryAddress
Адрес доставки
Строка
Да
Москва, ул. Муссы
Джалиля, д. 26,
корп. 1
orderId
orderNum
eshopOrderNum
Описание
Тип
Пример
123456
10.7. Входящее сообщение веб-методов
Параметр
Описание
Тип
Обяза
тельн
ый
Пример
request
Auth
sessionId
Идентификатор сессии,
полученный методом
getShipmentList
Число
Да
orderId
Идентификатор заказа,
полученный методом
Число
Да
64
23854956
Параметр
Описание
Тип
Обяза
тельн
ый
Пример
getShipmentList
10.8. Параметры ответного сообщения IsAddressChangeable
Параметр
isChangeable
Описание
Признак доступности
адреса доступности для
изменений
Тип
Логический
Обязательный
Пример
false/true
Тип
Строка
Обязательный
Да
Пример
Строка
Да
9:00-18:00
Число
Да
234
10.9. Параметры ответного сообщения getDeliveryDate
Параметр
date
interval
intervalId
Описание
Дата плановой доставки из
заказа
Наименование интервала
доставки из заказа
Идентификатор интервала
доставки в системе DPD
10.10. Параметры ответного сообщения getDeliveryIntervalList
Параметр
deliveryInterval
Описание
Список интервалов
доставки доступных для
выбора
Тип
Обязательный
Нет
Пример
Тип interval
Обязательный
Да
Пример
123
Строка
Да
9:00-18:00
Тип interval
Тип interval
Параметр
intervalId
interval
Описание
Идентификатор интервала
доставки в системе DPD
Наименование интервала
доставки
Тип
10.11. Параметры ответного сообщения getParselShopList
Параметр
ParcelShop
Описание
Список доступных для
самовывоза пунктов
выдачи
Тип
Обязательный
Нет
Пример
Тип
Тип interval
Обязательный
Да
Пример
123
Строка
Да
Тип
Тип department
departmentId
Параметр
Описание
Идентификатор терминала
доставки в системе DPD
department
Наименование терминала
доставки
10.12. Параметры ответного сообщения getAddress
Параметр
Описание
Тип
contactor
Наименование получателия
Строка
Обязател
ьный
Да
contact
Контактное лицо получателя
Строка
Да
65
Пример
Иванов ПП
Параметр
courierInstruction
Комментарий для курьера
Строка
Обязател
ьный
Да
country
Страна
Строка
Да
zipcode
Индекс
Строка
Нет
cityId
Идентификатор города в
системе DPD
Адрес строковый
Строка
Да
Строка
Да
Идентификатор улицы в
системе DPD
Наименование улицы
Число
Да
Строка
Да
Число
Да
bilding
Идентификатор
аббревиатуры улицы в
системе DPD
Номер дома
Строка
Нет
korp
Номер корпуса
Строка
Нет
str
Номер строения
Строка
Нет
vlad
Строка
Нет
office
Номер владения.
Один из параметров
(дом/корпус/строение/владен
ие) должен быть обязательно
заполнен
Номер офиса
Строка
Нет
flat
Номер квартиры
Строка
Нет
needPass
Признак необходимости
пропуска для курьера на
въезд на территорию
получателя
Номер телефона получателя
Целое
число
Нет
Строка
Да
Электронный почтовый адрес
получателя
Строка
Нет
address
streetId
Street
streetAbbrId
phone
email
Описание
Тип
Пример
10.13. Параметры ответного сообщения getStreetList
Параметр
street
Описание
Список улиц города
доставки
Тип
Массив
Обязательный
Да
Пример
Тип street
Тип street
Параметр
Описание
Тип
streetId
Идентификатор улицы в
системе DPD
Тип interval
Обяза
тельн
ый
Да
street
Наименование улицы
Строка
Да
66
Пример
123
Ул. Ленина
Параметр
abbrId
Описание
Тип
Идентификатор
аббревиатуры улицы в
системе DPD
Число
Обяза
тельн
ый
Да
Пример
10.14. Параметры ответного сообщения saveDeliveryDate
Параметр
isOk
Описание
Признак изменения заказа
в системе DPD
Тип
Логический
Обязательный
Да
Пример
false/true
Обязательный
Нет
Пример
Обязательный
Да
Пример
false/true
Обязательный
Да
Пример
false/true
10.15. Параметры ответного сообщения getWebSite
Параметр
url
Описание
Ссылка на страницу пункта
выдачи
Тип
Строка
10.16. Параметры ответного сообщения cancelOrder
Параметр
isOk
Описание
Признак изменения заказа
в системе DPD
Тип
Логический
10.17. Параметры ответного сообщения saveAddress
Параметр
isOk
Описание
Признак изменения заказа
в системе DPD
Тип
Логический
10.18. Параметры ответного сообщения getDeliveryDateList
Параметр
deliveryDate
Описание
Список дат к выбору
Тип
Массив
Строка
Обязательный
Нет
Пример
10.19. Статусы сообщений
Код Status
Описание
200
400
403
480
481
OK;
ошибки request: не заданы поля, недопустимые значения, и т.п.;
ошибки аутентификации;
в Аргис не установлены настройки, связанные с правами клиента;
недопустимое состояние объекта в Аргис, например, состояние заказа не
позволяет его изменять;
данные не найдены;
внутренняя обработанная ошибка;
необработанные exceptions.
482
520
500
Статусы, кроме 200 сопровождаются сообщениями.
67
V. Справочник ошибок
1. Общие ошибки
Код ошибки
system-error
Текст ошибки
Системная ошибка
too-many-calls
Превышен лимит
одновременных
вызовов сервиса
call-client-twin
Повторный вызов
сервиса по одному
коду клиента
client-num-error
Не найден номер
клиента
auth-error
Ошибка в
параметрах
аутентификации
Не заданы значения
обязательных полей
required-value
error-value
Недопустимое
значение поля
Примечание
Не типизированная ошибка. Обратитесь
на itcustomers@dpd.ru
На сервере DPD установлено
ограничение на частоту вызовов сервиса
с одного клиентского номера.
Попробуйте уменьшить частоту вызова
сервиса.
На сервере DPD установлено
ограничение на количество
одновременных вызовов сервиса.
Попробуйте уменьшить частоту вызова
сервиса.
На сервере DPD установлено
ограничение, не допускающее более
одного вызова сервиса с одного
клиентского номера. Попробуйте
уменьшить частоту вызова сервиса.
Уникальный ключ клиента не
соответствует номеру клиента.
Обратитесь на itcustomers@dpd.ru
Проверьте алгоритм заполнения всех
обязательных полей входного
сообщения.
Проверьте алгоритм заполнения полей,
имеющих ограниченный набор значений
(«Услуга», «Вариант доставки» и пр.)
2. Ошибки службы «Расчёт стоимости»
Код ошибки
no-service-available
no-data-found
too-many-rows
Текст ошибки
Невозможна услуга,
удовлетворяющая
запросу
Данные не найдены
Найдено более
одной записи данных
Примечание
Доставка груза по данной услуге
невозможна. Попробуйте задать другое
направление, услугу или дату доставки.
По заданным параметрам не найден
пункт отправления и пункт назначения.
По заданным параметрам найдено
более одного пункта отправления и
пункта назначения.
3. Ошибки службы «Создание заказа»
Код ошибки
no-data-found
Текст ошибки
Данные не найдены
too-many-rows
Найдено более
одной записи данных
68
Примечание
По заданным параметрам не найдено ни
одного заказа. Проверьте корректность
указанного номера или попробуйте
изменить дату приёма груза.
По заданным параметрам найдено
более одного заказа. Попробуйте указать
дату приёма груза, чтобы сузить область
поиска.
4.
Ошибки службы «Отслеживание статуса»
Код ошибки
no-data-found
Текст ошибки
Данные не найдены
too-many-rows
Найдено более
одной записи данных
no-setting
Не предусмотрены
настройки
date-before-start
Дата запрошенного
объекта ранее
подключения клиента
к сервису
Запрос не
предполагает
подтверждения
confirm-not-required
Примечание
По заданным параметрам не найдено ни
одного заказа. Проверьте корректность
указанного номера или попробуйте
изменить дату приёма груза.
По заданным параметрам найдено
более одного заказа. Попробуйте указать
дату приёма груза, чтобы сузить область
поиска.
Для указанного клиента не указаны
настройки службы отслеживания.
Обратитесь к вашему менеджеру или
напишите на itcustomers@dpd.ru
Вы можете получать статусы заказов,
созданных в системе после вашего
подключения к сервису. Выдача статусов
«задним числом» не поддерживается.
Вы попытались вызвать запрос
подтверждения, но ваши настройки не
предполагают подтверждения.
Обратитесь на itcustomers@dpd.ru ,
чтобы изменить эти настройки.
5. Ошибки службы «Создание адреса с кодом»
Код ошибки
code-already-exists
Текст ошибки
Адрес с указанным
кодом уже
существует
address-error
Адрес не может быть
создан.
code-not-found
Адрес с указанным
кодом не найден.
Примечание
Адрес с указанным кодом уже
существует. Обратитесь к вашему
менеджеру или напишите на
itcustomers@dpd.ru
Не для всех параметров адреса заданы
значения. Необходимо указать
недостающие значения.
По указанному коду не найден адрес.
Необходимо создать адрес.
6. Ошибки службы «Печать Наклейки»
Код ошибки
no-data-found
input-data-error
illegal-state
Текст ошибки
Заказ № для клиента
№ не найден
У заказа № дата
забора ранее
текущей даты
Состояние заказа №
не позволяет
создавать наклейки
69
Примечание
Ошибка в номере заказа
Заказ устарел
Заказ уже переведен в состояние, не
позволяющее формировать наклейки.
Например, посылки уже получены у
клиента.
VI.Контакты
По всем вопросам, связанным с использованием нашего интеграционного модуля, обращайтесь в
службу информационной поддержки DPD: itcustomers@dpd.ru
70