описание API интергации - Курьерская служба доставки

1. Общее описание
В документе представлен порядок и формат обмена данными между Компанией «Почтальон Сервис» и клиентом
Интернет-Магазином (далее ИМ).
Запросы на генерацию учетной записи, вопросы и пожелания клиентов принимаем на email ko@pmsv.ru
2. Протокол обмена
1.
Обмен данными осуществляется по протоколу HTTPS.
Адрес сервера для отправки запросов:
https://my.pmsv.ru/api
Данные передаются в формате XML, при этом необходимо учитывать, что в значениях полей нельзя использовать
символы разметки XML ( < > & " ' ), кодировка UTF-8.
2.
Идентификация ИМ осуществляется двумя параметрами: учетная запись account и секретный код secure.
Важно: Учетная запись для интеграции не совпадает с учетной записью доступа в Личный Кабинет.
При отпрвке запроса Secure отправляется в виде md5(текущая дата в формате "Y-m-d" и & и сам Secure)
Пример php: md5( date('Y-m-d').'&'.$Secure)
ИМ отправляет POST запрос на адрес:
 для документа «Список заказов на доставку»
 для документа «Статус заказов»
https://my.pmsv.ru/api/newzayavka.php;
https://my.pmsv.ru/api/status.php.
с заполненной переменной $_POST['xml_request'], в которой передается содержимое XML фaйла.
Сервер вернет результат в виде:
3. Загрузка новых заявок
<?xml version="1.0" encoding="UTF-8" ?>
<DeliveryRequest Number="2013457" Date="2014-12-01" Account="esd32342afdsd434serdd43"
Secure="jlk233534sdf34tgdfs" OrderCount="2" ReportType="1">
<Order Usluga="2" Number="123456" Count="2" Comment="">
<Recipient Name="Получатель" Phone="79161234567" />
<Address Metro="188" RecCityCode="1" Street="1-я Ямская улица" House="8" Flat="1" />
<Package Cost="1000" Payment="1000" />
<Schedule Date="2014-12-20" TimeBeg="10:00:00" TimeEnd="18:30:00" />
</Order>
</DeliveryRequest>
DeliveryRequest
Number
Int
Номер заявки
Date
Date (UTC(0000-00-00))
Дата заявки
Account
String
Account
Secure
String
Secure
OrderCount
Int
Количество заказов в заявке
ReportType
Int
Тип ответа сервера
Order
Usluga
Int
Услуга*
Number
String
Номер заказа
Count
Int
Количество коробок в заказе
Comment
String
Коментарий к заказу
Recipient
Name
String
Номер заявки
Phone
String(79161234567)
Дата заявки
Address
Metro
Int
Метро доставки***
RecCityCode
Int
Регион доставки**
Street
String
Улица
House
String
Номер дома
Flat
String
Квартира, офис
Package
Cost
Float
Оценка заказа
Payment
Float
Прием денег
Schedule
Date
Date (UTC(0000-00-00))
Дата доставки
TimeBeg
Time (UTC(00:00:00))
Интервал доставки С
TimeEnd
Time (UTC(00:00:00))
Интервал доставки По
*Приложение 1
**Приложение2
*** Указывается обязательно если указывается услуга Самовывоза, Список ПВЗ Приложение 3
или по умолчанию должно быть 188, Список метро Приложение 4
Ответы сервера на запрос на добавление заказов:
Ответ сервера о добавлении заявки
<?xml version="1.0" encoding="UTF-8" ?>
<DeliveryReport Date="2015-01-22" OrderCount="1">
<Order Number="123456" Status="Ok" DispatchNumber="15248852" />
</DeliveryReport>
В случае правильной загрузки заявки на сервер Почтальон Сервис, Вам будет
отправлен ответ с содержанием:
DeliveryReport
Date
Date (UTC(0000-00-00))
Дата ответа
OrderCount
Int
Кол-во заказов в ответе
Order
Number
String
Номер вашего заказа
Status
String
Статус загрузки заявки
DispatchNumber
Int
Внутренний номер из системы
Почтальон Сервис
Ответ сервера о наличии ошибок в запросе
<?xml version="1.0" encoding="UTF-8" ?>
<DeliveryReport Date="2015-01-21" OrderCount="1">
<Order Number="123456" Status="Error">
<Error Description="Неуказан Получатель" />
<Error Description="Неуказан Телефон получателя" />
<Error Description="С данной услугой сумма не может быть больше "0"" />
<Error Description="Неверная дата доставки" />
<Error Description="Ошибка интервала, в декабре доставка с 10.00-18.00" />
</Order>
</DeliveryReport>
В случае НЕ правильной загрузки заявки на сервер Почтальон Сервис, Вам будет
отправлен ответ с содержанием:
DeliveryReport
Date
Date (UTC(0000-00-00))
Дата ответа
OrderCount
Int
Кол-во заказов в ответе
Order
Number
String
Номер вашего заказа
Status
String
Статус загрузки заявки
DispatchNumber
В случае не верно заполненным или не правильно загруженным
запросом в ответе не будет содержаться внутренний номер заказа
из системы Почтальон Сервис
Виды ошибок:
Не указана услуга
Не указан номер заказа
Заказ с таким номером уже есть
Не указано кол-во коробок в заказе
Не указан Получатель
Не указан Телефон получателя
Не указана Сумма
Не верно указана Оценка заказа
Не верное метро с Услугой Самовывоз
С данной услугой сумма не может быть больше "0"
С данной услугой сумма не может быть равна "0"
С данной услугой не может быть регион Москва
Данная услуга предоставляется только в Москве
Не указан Город доставки
Не указана Станция метро
Не указана Улица доставки
Не указан Номер дома
Не указана Квартира или офис
Неверная дата доставки
Ошибка интервала, в декабре доставка с 10.00-18.00
Ошибка интервала, Интервал менее 3-х часов
Ошибка Идентификации пользователя
Ошибка XML Файла
4. Проверка Статуса заказов
<?xml version="1.0" encoding="UTF-8" ?>
<DeliveryRequest Date="2014-12-01" Account="esd32342afdsd434serdd43" Secure="jlk233534sdf34tgdfs"
OrderCount="1" ReportType="1">
<Order DispatchNumber="236170"/>
</DeliveryRequest>
Ответ на запрос статуса:
<?xml version="1.0" encoding="UTF-8" ?>
<StatusReport Date="2015-01-21" OrderCount="2">
<Order DispatchNumber="236170">
<Error Type="Не существующий DispatchNumber" />
</Order>
<Order DispatchNumber="127023">
<Status Number="U750П" Id="3" Datetime="2014-02-04 14:04:20" />
<Status Number="U750П" Id="2" Datetime="2014-02-04 03:36:30" />
<Status Number="U750П" Id="1" Datetime="2014-02-03 22:21:08" />
</Order>
</StatusReport>
Приложение 1
Услуги:
id
1
3
4
5
7
8
9
11
12
14
16
17
21
22
Type
24
24КО
ПР
Забор
С24КО
С24
В24
СХ
ВС24
РЕГ24
РЕГ24КО
ВРЕГ24
СРЕГ24
СРЕГ24КО
Description
без приема наличных
Кассовое обслуживание
Почта
Забор
Самовывоз с кассовым обслуживанием
Самовывоз без приема наличных
Возврат без приема наличных
Складское хранение
Возврат без передачи наличных в пункте самовывоза
Доставка в Регионы без приема наличных
Доставка в Регионы с кассовым обслуживанием
Возврат в Регионах без приема наличных
Самовывоз в Регионах без приема наличных
Самовывоз в Регионах с кассовым обслуживанием
Приложение 2
Регионы:
id
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
Название Региона
Москва
Санкт-Петербург
Нижний Новгород
Тверь
Калуга
Ярославль
Екатеринбург
Тюмень
Челябинск
Ростов-на-Дону
Александров
Белгород
Брянск
Великий Новгород
Владимир
Волгоград
Вологда
Воронеж
Гатчина
Дзержинск
Волгодонск
Волжский
Димитровград
Иваново
Казань
Кострома
Краснодар
Курск
Липецк
Обнинск
Орел
Псков
Рыбинск
Рязань
Самара
Сосновый Бор
Смоленск
Старый Оскол
Тамбов
Тула
Чебоксары
Череповец
Альметьевск
id
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
Название Региона
Балаково
Березники
Владикавказ
Златоуст
Ижевск
Йошкар-Ола
Калининград
Керчь
Киров
Кисловодск
Курган
Магнитогорск
Миасс
Минеральные Воды
Мурманск
Набережные
Челны
Нальчик
Нефтекамск
Нижний Тагил
Нижнекамск
Новороссийск
Новочеркасск
Оренбург
Орск
Пенза
Пермь
Петрозаводск
Пятигорск
Салават
Саранск
Саратов
Севастополь
Симферополь
Сочи
Ставрополь
Стерлитамак
Сыктывкар
Таганрог
Тольятти
Ульяновск
Уфа
Черкесск
44
45
id
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
Армавир
Астрахань
Название Региона
Южноуральск
Ачинск
Барнаул
Бердск
Бийск
Горно-Алтайск
Кемерово
Красноярск
Междуреченск
Новокузнецк
Новосибирск
Омск
Прокопьевск
Рубцовск
Северск
Томск
Абакан
Артём
Архангельск
Благовещенск
Братск
Владивосток
89
90
id
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
Чусовой
Шахты
Название Региона
Грозный
Иркутск
Комсомольск-на-Амуре
Махачкала
Нарьян-Мар
Находка
Нижневартовск
Сургут
Улан-Удэ
Уссурийск
Хабаровск
Ханты-Мансийск
Хасавюрт
Чита
Южно-Сахалинск
Белоярский
Магадан
Надым
Новый Уренгой
Норильск
Петропавловск-Камчатский
Приложение 3
Список ПВЗ:
id
12
32
38
86
119
145
193
Название
Багратионовская
Войковская
Динамо
Новогиреево
Пушкинская
Теплый стан
Сенная площадь
Регион
Москва
Москва
Москва
Москва
Москва
Москва
Санкт-Петербург
Приложение 4
id
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Название
Авиамоторная
Автозаводская
Академическая
Александровский сад
Алексеевская
Алтуфьево
Аннино
Арбатская
Арбатская
Аэропорт
Бабушкинская
Багратионовская
Баррикадная
Бауманская
Беговая
Белорусская
Беляево
Бибирево
Библиотека имени Ленина
Битцевский парк
Боровицкая
Ботанический сад
Братиславская
Бульвар адмирала
Ушакова
Бульвар Дмитрия Донского
Бунинская аллея
Варшавская
ВДНХ
Владыкино
Водный стадион
Войковская
Волгоградский проспект
Волжская
Воробьевы горы
Выхино
Деловой центр
Динамо
Дмитровская
Добрынинская
Домодедовская
Дубровка
Измайловская
Калужская
Кантемировская
Каховская
id
47
48
49
51
52
53
54
55
57
58
59
60
61
62
63
64
65
66
67
68
69
70
72
Название
Каширская
Каширская
Киевская
Киевская
Китай-город
Китай-город
Кожуховская
Коломенская
Комсомольская
Коньково
Красногвардейская
Краснопресненская
Красносельская
Красные ворота
Крестьянская застава
Кропоткинская
Крылатское
Кузнецкий мост
Кузьминки
Кунцевская
Кунцевская
Курская
Кутузовская
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
92
93
94
95
Ленинский проспект
Лубянка
Люблино
Марксистская
Марьино
Маяковская
Медведково
Международная
Менделеевская
Молодежная
Нагатинская
Нагорная
Нахимовский проспект
Новогиреево
Новокузнецкая
Новослободская
Новые Черемушки
Октябрьская
Октябрьское поле
Орехово
Отрадное
Охотный ряд
id
96
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
141
142
143
144
145
146
Название
Павелецкая
Парк Культуры
Парк Победы
Партизанская
Первомайская
Перово
Петровско-Разумовская
Печатники
Пионерская
Планерная
Площадь Ильича
Площадь Революции
Полежаевская
Полянка
Пражская
Преображенская площадь
Пролетарская
Проспект Вернадского
Проспект Мира
Профсоюзная
Пушкинская
Речной вокзал
Рижская
Римская
Рязанский проспект
Савеловская
Свиблово
Севастопольская
Семеновская
Серпуховская
Славянский бульвар
Смоленская
Смоленская
Сокол
Сокольники
Спортивная
Сретенский бульвар
Строгино
Студенческая
Сухаревская
Сходненская
Таганская
Тверская
Театральная
Текстильщики
Теплый стан
Тимирязевская
id
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
Название
Третьяковская
Третьяковская
Трубная
Тульская
Тургеневская
Тушинская
Улица 1905 года
Улица академика Янгеля
Улица Горчакова
Улица Подбельского
Улица Скобелевская
Улица Старокачаловская
Университет
Филевский парк
Фили
Фрунзенская
Царицыно
Цветной бульвар
Черкизовская
Чертановская
Чеховская
Чистые пруды
Чкаловская
Шаболовская
Шоссе Энтузиастов
Щелковская
Щукинская
Электрозаводская
Юго-Западная
Южная
Ясенево
Достоевская
Марьина роща
Выставочная
Волоколамская
Митино
Новоясеневская
Мякинино
Борисово
Шипиловская
Зябликово
Нет метро
Новокосино
Алма-Атинская
Лермонтовский проспект
Жулебино
Сенная площадь
Приложение 5
Статусы:
id
1
2
3
4
5
6
7
8
9
10
11
12
status
На складе
На доставке
Доставлен
Перенос
Отменен
В пути
Отказ на адресе
Отказ с оплатой
Доставлен частично
Не поступал
Возврат
Заявка