Вы находитесь на странице: 1из 32

Содержание

Работа с API Новой Почты ...............................................................................................................................2


Справочник Городов....................................................................................................................................2
Справочник отделений ...............................................................................................................................3
Справочник Населенных пунктов ..............................................................................................................7
Справочник улиц в Населенных пунктах ..............................................................................................9
Онлайн-поиск в справочниках .................................................................................................................10
Онлайн-поиск в справочнике Населенных пунктов ..........................................................................10
Онлайн поиск улиц в справочнике населенных пунктов..................................................................11
АПИ-методы для получения данных об Отправителе ..........................................................................12
Получение реф-идентификатора Отправителя..................................................................................12
Получение реф-идентификатора Контактного лица Отправителя ..................................................13
Создание адреса Отправителя (если отправка от адреса) ...............................................................14
Получение справочника адресов Отправителя .................................................................................15
Формирование запроса на создание накладной ..................................................................................16
Создание накладной на почтомат НП .....................................................................................................22
Редактирование созданной накладной ..................................................................................................23
Работа с реестрами ....................................................................................................................................25
Ограничения при работе с реестрами .................................................................................................28
Получение печатной формы реестра ..................................................................................................29
Получение печатных форм экспресс-накладных и маркировок .........................................................29
Получение печатной формы экспресс-накладной ............................................................................29
Получение печатных форм маркировок ............................................................................................29
Трекинг ........................................................................................................................................................30
Актуальные статусы трекинга ...............................................................................................................30
Работа с API Новой Почты
API (интерфейс программирования приложений) - это набор инструментов для автоматизации работы с
компанией «Нова пошта». Функциональность API позволяет быстро интегрировать логистические процессы в
любой бизнес и является единственной точкой входа для всех клиентов и сервисов.

API key - для начала работы с функционалом АРI компании «Нова пошта» необходимо сгенерировать ключ API
и использовать его при формировании запросов. Ключ можно сгенерировать в меню личного кабинета , раздел
Налаштування—Безпека https://new.novaposhta.ua/#/1/settings/developers.

Точки входа:
JSON - https://api.novaposhta.ua/v2.0/json/
XML - https://api.novaposhta.ua/v2.0/xml/

Формат запроса - обмен данными с помощью API осуществляется по протоколу HTTPS с использованием
способа передачи данных POST или GET на точку входа в зависимости от типа запроса XML или JSON.

Работа со справочниками

Основными используемыми справочниками являются: справочник Городов Компании, Справочник Отделений


НП, Справочник населенных пунктов. Также может использоваться Справочник улиц.

Справочник Городов
Метод «getCities» работает в модели «Address», этот метод загружает справочник городов
Украины, где есть отделения "Нова Пошта"
Если в этот запрос добавить параметр «FindByString» (поиск по строкам) и в его свойствах
прописать название населенного пункта , который нужно найти, то получим запрос, с
помощью которого в справочнике находится населенный пункт.
"methodProperties": {
"FindByString": "Бровари"
}
Пример запроса с минимальным набором параметров
{
"modelName": "Address",
"calledMethod": "getCities",
"methodProperties": { },
"apiKey": ""
}
Структура ответа
…{
"Description": "Київ", -название города на украинском языке
"DescriptionRu": "Киев",-название города на русском языке
"Ref": "8d5a980d-391c-11dd-90d9-001a92567626", - реф-идентификатор города
"Delivery1": "1",

2
"Delivery2": "1",
"Delivery3": "1",
"Delivery4": "1",
"Delivery5": "1",
"Delivery6": "1",
"Delivery7": "0",
"Area": "71508131-9b87-11de-822f-000c2965ae0e",
"SettlementType": "563ced10-f210-11e3-8c4a-0050568002cf",
"IsBranch": "1",
"PreventEntryNewStreetsUser": null,
"Conglomerates": [
"d4771ed0-4fb7-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac",
"f86b75e9-42f4-11e4-91b8-2f592fe1dcac"
],
"CityID": "4",
"SettlementTypeDescription": "місто",
"SettlementTypeDescriptionRu": "город",
"SpecialCashCheck": 1
},…

ВАЖНО: Из справочника Городов Компании, загружаемого по запросу getCities, необходимо


использовать реф-идентификатор города, который в АПИ-запросе на создание накладной
будет указан в блоке данных отправителя в параметре CitySender.
Справочник отделений
Метод «getWarehouses», работает в модели «Address», этот метод загружает актуальный
справочник отделений «Новой Почты».

3
Есть возможность отфильтровать отделения по следующим признакам:
1) TypeOfWarehouseRef – реф-идентификатор типа отделения
2) CityName – название города согласно справочнику Городов
3) CityRef – реф-идентификатор города согласно справочнику Городов
Пример:
"methodProperties": {

"TypeOfWarehouseRef":"9a68df70-0267-42a8-bb5c-37f427e36ee4",
""CityName":"Київ"
"CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",
}
Также предусмотрена возможность получения данных по отделениям в конкретном нас.
пункте, по реф-идентификатору нас.пункта, полученному при помощи метода getSettlements
Пример:
"methodProperties": {
"SettlementRef": "e71629ab-4b33-11e4-ab6d-005056801329" //РЕФ населенного пункта из
справочника населенных пунктов
}
Пример запроса для получения справочника отделений
{
"modelName": "Address",
"calledMethod": "getWarehouses",
"methodProperties": { },
"apiKey": ""
}
Структура ответа на запрос, с описаниями значений параметров
…{
"SiteKey": "105",

"Description": "Відділення №1: вул. Пирогівський шлях, 135", -- описание отделения на


украинском языке

"DescriptionRu": "Отделение №1: ул. Пироговский путь, 135",-- описание отделения на


русском языке
"ShortAddress": "Київ, Пирогівський шлях, 135", - краткий адрес на укр.языке
"ShortAddressRu": "Киев, Пироговский путь, 135", - краткий адрес на русском языке
"Phone": "380800500609",

4
"TypeOfWarehouse": "9a68df70-0267-42a8-bb5c-37f427e36ee4", -- реф-идентификатор
типа отделения
"Ref": "1ec09d88-e1c2-11e3-8c4a-0050568002cf", --реф-идентификатор отделения
"Number": "1", -- номер отделения
"CityRef": "8d5a980d-391c-11dd-90d9-001a92567626", - идентификатор города согласно
справочнику Городов (getCities)
"CityDescription": "Київ", - название города на укр. согласно справочнику Городов
(getCities)
"CityDescriptionRu": "Киев",- название города на русском согласно справочнику
Городов (getCities)

"SettlementRef": "e718a680-4b33-11e4-ab6d-005056801329", - реф-идентификатор


населенного пункта согласно справочнику Населенных пунктов (getSettlements)

"SettlementDescription": "Київ", -- название населенного пункта согласно справочнику


Населенных пунктов (getSettlements)

"SettlementAreaDescription": "Київська", -- название области для населенного пункта


согласно справочнику Населенных пунктов (getSettlements)
"SettlementRegionsDescription": "", -- название района для населенного пункта
согласно справочнику Населенных пунктов (getSettlements)
"SettlementTypeDescription": "місто", -- тип населенного пункта согласно справочнику
Населенных пунктов (getSettlements)
"Longitude": "30.542884000000000", -- долгота
"Latitude": "50.354786000000000", -- широта
"PostFinance": "1", -- Наличие кассы Пост-Финанс (1=да/0=нет))
"BicycleParking": "1",
"PaymentAccess": "1",
"POSTerminal": "1", -- Наличие пос-терминала на отделении (1=да/0=нет)

"InternationalShipping": "0", Возможность оформления Международного отправления


(1=да/0=нет)
"SelfServiceWorkplacesCount": "0",
"TotalMaxWeightAllowed": 0, -- Максимальный вес отправления (0 означает отсутствие
ограничения)
"PlaceMaxWeightAllowed": "1100", -- Максимальный вес одного места отправления (0
означает отсутствие ограничения)
"Reception": { -- График приема отправлений

5
"Monday": "08:00-22:00",
"Tuesday": "08:00-22:00",
"Wednesday": "08:00-22:00",
"Thursday": "08:00-22:00",
"Friday": "08:00-22:00",
"Saturday": "08:00-19:00",
"Sunday": "09:00-18:00"
},
"Delivery": { -- График отправки день в день
"Monday": "08:00-18:00",
"Tuesday": "08:00-18:00",
"Wednesday": "08:00-18:00",
"Thursday": "08:00-18:00",
"Friday": "08:00-18:00",
"Saturday": "08:00-18:00",
"Sunday": "09:00-16:00"
},
"Schedule": { -- График работы отделения
"Monday": "08:00-19:00",
"Tuesday": "08:00-22:00",
"Wednesday": "08:00-22:00",
"Thursday": "08:00-22:00",
"Friday": "08:00-22:00",
"Saturday": "08:00-19:00",
"Sunday": "09:00-18:00"
},
"DistrictCode": "в1",
"WarehouseStatus": "Working",
"CategoryOfWarehouse": "Branch",
"Direct": ""

6
},…

Из справочника отделений, загружаемого по запросу getWarehouses, необходимо


использовать реф-идентификатор отделения (поле Ref в ответе), который в запросе на
создание накладной по АПИ может быть указан:
-- в блоке данных отправителя в параметре SenderAddress (если отправка от отделения НП),
-- в блоке данных получателя в параметре RecipientWarehouseRef (если доставка на
отделение НП и отделение указывается в виде реф-идентификатора)
Номер отделения (поле Number в ответе) может использоваться в блоке данных получателя
в параметре RecipientAddressName (если доставка на отделение и отделение указывается
строкой (номер отделения), а не реф-идентификатором).
Справочник Населенных пунктов
Метод «getSettlements» позволяет загрузить справочник населенных пунктов Украины, в
которые осуществляется доставка груза компанией «Новая Почта» - как на отделения, так и
на адрес.
Метод отдает не более 150 записей на страницу.

Для загрузки справочника в полном объеме постранично, необходимо использовать


параметр "Page": "1", в виде цикла, условием выхода из цикла будет пустота в блоке
данных.
Также в методе доступен поиск по строке, для него нужно указать
параметр FindByString. Важно! Поиск возможен только на Украинском языке. Пример:
"methodProperties": {
"FindByString": "Бровари"
}
Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в
актуальном состоянии.
Рекомендуется проводить обновление справочника еженедельно.
Параметр в ответе "Warehouse": "1 или 0" указывает на наличие отделений Нова пошта в
населенном пункте.
Пример запроса
{
"modelName": "AddressGeneral",
"calledMethod": "getSettlements",
"methodProperties": {
"Page": 1
},
"apiKey": ""

7
}

Фрагмент ответа на запрос, с описаниями значений параметров


[
{
"Ref": "e71f7424-4b33-11e4-ab6d-005056801329", - реф
идентификатор населенного пункта
"SettlementType": "563ced10-f210-11e3-8c4a-0050568002cf", -
реф идентификатор типа населенного пункта
"Latitude": "48.330028000000000", - широта
"Longitude": "30.232109000000000", - долгота
"Description": "Благовіщенське", - название нас.пункта на
украинском языке
"DescriptionRu": "Благовещенское",- название нас.пункта на
русском языке
"SettlementTypeDescription": "місто", - тип нас.пункта на
украинском языке
"SettlementTypeDescriptionRu": "город", - тип нас.пункта на
русском языке
"Region": "e4b0d307-4b33-11e4-ab6d-005056801329", - реф
идентификатор района
"RegionsDescription": "Благовіщенський р-н", - название
района на украинском языке
"RegionsDescriptionRu": "Благовещенский р-н", - название
района на русском языке
"Area": "dcaadbf9-4b33-11e4-ab6d-005056801329", - реф
идентификатор области
"AreaDescription": "Кіровоградська область", - название
области на украинском языке
"AreaDescriptionRu": "Кировоградская область", - название
области на русском языке
"Index1": "26400", - почтовый индекс от
"Index2": "26400", - почтовый индекс до
"IndexCOATSU1": "3525510100",
"Delivery1": "1",

8
"Delivery2": "1",
"Delivery3": "1",
"Delivery4": "1",
"Delivery5": "1",
"Delivery6": "0",
"Delivery7": "0",
"SpecialCashCheck": 1,
"Warehouse": "1" – наличие отделений НП в данном населенном
пункте
},

Из справочника населенных пунктов, загружаемого по запросу getSettlements, необходимо


использовать реф-идентификатор населенного пункта (поле Ref в ответе), который в запросе
на создание накладной по АПИ может быть указан в блоке данных получателя в параметре
RecipientCityRef .

Если данные о населенном пункте Получателя передаются не в виде реф-идентификатора, а


в виде строк, тогда в запросе на создание накладной по АПИ будут использоваться значения,
взятые из параметров Description, RegionsDescription, AreaDescription,
SettlementTypeDescription . В запросе на создание ИД это будут параметры, соответственно,
"RecipientCityName", "RecipientAreaRegions", "RecipientArea", "SettlementType".
Справочник улиц в Населенных пунктах
Метод «getSettlementStreets» позволяет загрузить справочник улиц в населенном пункте. В
параметре SettlementRef необходимо передать реф-идентификатор населенного пункта
согласно справочнику населенных пунктов (getSettlements).

Для загрузки справочника в полном объеме постранично, необходимо использовать


параметр "Page": "1", в виде цикла, условием выхода из цикла будет пустота в блоке
данных.
Пример запроса
{
"apiKey": "",
"modelName": "Address",
"calledMethod": "getSettlementStreets",
"methodProperties": {

"SettlementRef": "e716f975-4b33-11e4-ab6d-005056801329"

9
}
}
Фрагмент ответа на запрос
{
"Description": "1-го Травня", -- название улицы на укр.языке
"DescriptionRu": "1-го Мая", -- название улицы на русском
языке
"Ref": "c502d906-4bbe-11e4-ab6d-005056801329", -- реф-
идентификатор улицы
"StreetsType": "вул.",
"StreetsTypeRef": "0f1d7fbb-4bba-11e4-ab6d-005056801329"
},

Из справочника улиц, загружаемого по запросу getSettlementStreets, необходимо


использовать реф-идентификатор улицы (поле Ref в ответе выше), который в API-запросе на
создание накладной может быть указан в блоке данных получателя в параметре
RecipientStreetRef (если доставка на адрес и улица передается в виде реф-идентификатора, а
не строки).

Онлайн-поиск в справочниках
Онлайн-поиск в справочнике Населенных пунктов
Метод «searchSettlements», работает в модели «Address», этот метод необходим для
онлайн-поиска населенных пунктов. Параметр CityName принимает название населенного
пункта на украинском языке либо почтовый индекс населенного пункта для поиска.
Пример запроса
{
"apiKey": "ВАШ КЛЮЧ",
"modelName": "Address",
"calledMethod": "searchSettlements",
"methodProperties": {
"CityName": "київ"
}
}
Фрагмент ответа на запрос
…{
"Present": "м. Київ, Київська обл.", - описание нас.пункта
"Warehouses": 705, - количество отделений НП в данном нас.пункте
"MainDescription": "Київ", - название населенного пункта на украинском языке
согласно справочнику Населенных пунктов

10
"Area": "Київська", - название области на украинском языке согласно справочнику
Населенных пунктов
"Region": "", - название района на украинском языке согласно справочнику
Населенных пунктов
"SettlementTypeCode": "м.", - сокращенное название типа населенного пункта
"Ref": "e718a680-4b33-11e4-ab6d-005056801329", - реф-идентификатор
населенного пункта согласно справочнику Населенных пунктов
"DeliveryCity": "8d5a980d-391c-11dd-90d9-001a92567626", - реф-идентификатор
города из справочника getCities, из которого осуществляется доставка в данный населенный
пункт
"StreetsAvailability": true,
"ParentRegionTypes": "область",
"ParentRegionCode": "обл.",
"RegionTypes": "",
"RegionTypesCode": ""
},…

Из ответа на запрос по методу searchSettlements, необходимо использовать реф-


идентификатор населенного пункта (поле Ref в ответе), который в АПИ-запросе на создание
накладной может быть указан в блоке данных получателя в параметре RecipientCityRef .

Если данные о населенном пункте Получателя передаются не в виде реф-идентификатора, а


в виде строк, тогда в запросе на создание накладной по АПИ будут использоваться значения,
взятые из параметров MainDescription, Area, Region. В запросе на создание ИД это будут
параметры, соответственно, "RecipientCityName", "RecipientArea", "RecipientAreaRegions".

Онлайн поиск улиц в справочнике населенных пунктов


Метод «searchSettlementStreets», работает в модели «Address», этот метод необходим для
ОНЛАЙН ПОИСКА улиц в выбранном населенном пункте. Поиск осуществляется по названию
(первым буквам названия) улицы на украинском языке.
Пример запроса
{
"apiKey": "ВАЩ КЛЮЧ",
"modelName": "Address",
"calledMethod": "searchSettlementStreets",
"methodProperties": {
"StreetName": "шолуденк", -- название улицы для поиска
"SettlementRef": "e718a680-4b33-11e4-ab6d-005056801329", -- реф-идентификатор
населенного пункта согласно справочнику Населенных пунктов
"Limit": 50
}
}

11
Фрагмент ответа на запрос
{
"SettlementRef": "e718a680-4b33-11e4-ab6d-005056801329", -- реф-идентификатор
населенного пункта согласно справочнику Населенных пунктов
"SettlementStreetRef": "a922cfc4-6848-11e6-8304-00505688561d", -- реф-
идентификатор улицы
"SettlementStreetDescription": "Шолуденко", - название улицы на украинском
языке
"Present": "вул. Шолуденко", - описание улицы на украинском языке
"StreetsType": "0f1d7fbb-4bba-11e4-ab6d-005056801329", - реф-идентификатор
типа улицы
"StreetsTypeDescription": "вул.", - сокращенное название типа улицы
"Location": [ -- координаты
50.452941991388997,
30.478049917147001
],
"SettlementStreetDescriptionRu": "Шолуденко"- название улицы на русском языке

Из ответа на запрос searchSettlementStreets, необходимо использовать реф-идентификатор


улицы (поле SettlementStreetRef в ответе выше), который в API-запросе на создание
накладной может быть указан в блоке данных Получателя в параметре RecipientStreetRef
(если доставка на адрес и улица передается в виде реф-идентификатора, а не строки).
АПИ-методы для получения данных об Отправителе
В АПИ-запросе на создание накладной, данные об Отправителе должны быть указаны в виде
реф-идентификаторов. Как правило, блок данных Отправителя в АПИ-запросе на создание
накладной подвергается изменениям не так часто.
Получение реф-идентификатора Отправителя
В персональный аккаунт (Личный Кабинет) Клиента, Отправитель подтягивается из нашей ИС
автоматически.

Для получения реф-идентификатора Отправителя (Отправителей) необходимо использовать


метод «getCounterparties» (работает в модели «Counterparty») с указанием типа
контрагента «Sender».
Пример запроса
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "getCounterparties",
"methodProperties": {
"CounterpartyProperty": "Sender"
}
}

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

…{
"Description": "СОнечКО ТОВ", - краткое название Отправителя
"Ref": "39ab7d9d-61d1-11e9-9937-005000801c6b", -- реф-идентификатор Отправителя
"City": "00000000-0000-0000-0000-000000000000",
"Counterparty": null,
"FirstName": "",
"LastName": "",
"MiddleName": "",
"CounterpartyFullName": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВIДПОВIДАЛЬНIСТЮ \"
СОнечКО\"", -- полное наименование Отправителя
"OwnershipFormRef": "7f0f351d-2519-11df-be9a-000c291af1b3",
"OwnershipFormDescription": "ТОВ",
"EDRPOU": "36049009",
"CounterpartyType": "Organization",
"CityDescription": ""
}…

Реф идентификатор Отправителя из ответа на запрос выше, необходимо использовать в


параметре Sender в апи-запросе на создание накладной.
Получение реф-идентификатора Контактного лица Отправителя
Контактные лица Отправителя либо подтягиваются в персональный аккаунт из нашей ИС
автоматически, либо (для корпоративных клиентов) могут быть созданы в Личном кабинете
или с помощью АПИ-метода.
Для получения списка контактных лиц Отправителя необходимо использовать
метод «getCounterpartyContactPerson» (работает в модели «Counterparty»).
{
"apiKey": "ВАШ АПИ-КЛЮЧ",
"modelName": "Counterparty",
"calledMethod": "getCounterpartyContactPersons",
"methodProperties": {
"Ref": "39ab7d9d-61d1-11e9-9937-005000801c6b ", -- реф-Идентификатор Отправителя
"Page": "1"
}
}

Фрагмент ответа
…{
"Description": "Пономаренко Юлія Юріївна", - ФИО контактного лица
"Phones": "380500000000",
"Email": "",
"Ref": "d9dcbe00-cc88-11e8-8b24-005056881c6b",-- реф-идентификатор контактного
лица
"LastName": "Пономаренко",

13
"FirstName": "Юлія",
"MiddleName": "Юріївна"
}
],

Реф- идентификатор (поле Ref в ответе выше) контактного лица отправителя необходимо
использовать в параметре ContactSender в АПИ-запросе на создание накладной.

Описания апи-методов для создания и редактирования Контактных лиц Отправителя будут


предоставлены отдельно в случае необходимости.
Создание адреса Отправителя (если отправка от адреса)
Создать адрес Отправителя можно по АПИ с помощью запроса на создание адреса.

Для создания адреса Отправителя (если отправка от адреса), необходимо использовать


запрос:

{
"modelName": "Address",
"calledMethod": "save",
"methodProperties": {
"CounterpartyRef": "5ace4a2e-13ee-11e5-add9-005056887b8d", -- Реф-идентификатор контраге
нта-Отправителя
"StreetRef": "d4450bdb-0a58-11de-b6f5-001d92f78697", -- Реф-идентификатор Улицы*(см. При
мечание)
"BuildingNumber": "7", - номер дома
"Flat": "2", -- номер квартиры (если есть)
"Note": "Комментарий" – комментарий к адресу (если необходимо)
},
"apiKey": "ВАШ КЛЮЧ"
}

*(Примечание) Запрос для получения реф-идентификатора улицы (Внимание: В приведенн


ом ниже запросе по методу getStreet поиск улицы выполняется по реф-идентификатору г
орода согласно справочнику getCities)
{
"modelName": "Address",
"calledMethod": "getStreet",
"methodProperties": {
"CityRef": "8d5a980d-391c-11dd-90d9-001a92567626", -- реф-идентификатор Города Отправ
ителя согласно справочнику getCities
"FindByString": "львівськ" - - поиск улицы по названию
},
"apiKey": ""
}

14
Полученный в ответе Реф-идентификатор улицы необходимо использовать в запросе на
создание адреса Отправителя.
Фрагмент ответа на запрос создания адреса отправителя
…{
"Ref": "e57f8afb-55f1-11e5-ad08-005056801333", -- реф идентификатор созданного адр
еса Отправителя
"Description": "Львівська вул. 7 кв. 2 Комментарий"
}…

Полученный в ответе реф-идентификатор адреса Отправителя необходимо использовать в А


ПИ-запросе на создание накладной в параметре SenderAddress (если отправка от адреса, а не
от отделения Новой Почты).

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

Если для Отправителя было создано несколько адресов отправки, получить данные по всем
этим адресам можно с помощью АПИ-запроса по методу getCounterpartyAddresses:

{
"apiKey": "", -- апи-ключ
"modelName": "Counterparty",
"calledMethod": "getCounterpartyAddresses",
"methodProperties": {
"Ref": "123bf97c-3bba-11e7-80c8-005056887b8d", -- реф-идентификатор Отправителя
"CounterpartyProperty": "Sender", -- тип контрагента - Отправитель
"Page": 1
}
}
Фрагмент ответа
…{
"Ref": "21463f65-a394-11e7-becf-005056881c6b", -- реф-идентификатор адреса
"Description": "Героїв Праці вул. 9", -- описание адреса
"CityRef": "db5c88e0-391c-11dd-90d9-001a92567626", - реф города согласно
справочнику getCities
"CityDescription": "Харків", - Название города на украинском языке согласно
справочнику getCities
"StreetRef": "a72a31de-416b-11dd-9198-001d60451983", - реф улицы (согласно
справочнику getStreet (в привязке к справочнику Городов, загружаемому по методу getCities)
"StreetDescription": "Героїв Праці", - Название улицы на украинском языке
"BuildingRef": "b139ae5b-bf9e-11de-9a0e-000c2965ae0e", - реф номера дома
"BuildingDescription": "9", - номер дома
"Note": "", - примечание (комментарий) к адресу
"AddressName": ""
},…

15
Полученный в ответе реф-идентификатор адреса Отправителя необходимо использовать в А
ПИ-запросе на создание накладной в параметре SenderAddress (если отправка от адреса, а не
от отделения Новой Почты).

Формирование запроса на создание накладной


Для создания накладной по АПИ, необходимо сформировать запрос по методу «save»,
который работает в модели «InternetDocument». АПИ-запрос будет состоять из
блока данных об отправителе, блока данных о получателе и дополнительных
параметров, характеризующих отправку.

Блок данных об отправителе включает в себя параметры:


"CitySender " - значением является реф-идентификатор города Отправителя
"Sender" - значением является реф-идентификатор Отправителя
"SenderAddress" – адрес отправителя, значением является реф адреса Отправителя
(если отправка от адреса) или реф идентификатор отделения Новой почты
(полученный из справочника по методу getWarehouses)
"ContactSender" – реф-идентификатор контактного лица Отправителя
"SendersPhone": "380501234567" – номер телефона контактного лица Отправителя

Блок данных о получателе (если получателем является частное лицо) включает в себя
параметры:

"RecipientCityRef": "", - реф-идентификатор города Получателя согласно


справочнику getSettlements. Реф-идентификатор позволяет уникальным образом
определить город Получателя, избавляя от необходимости передавать данные о
городе в виде строк в отдельных полях названия, области, района.

"RecipientWarehouseRef": "", - реф-идентификатор отделения Получателя согласно


справочнику getWarehouses. Реф-идентификатор отделения позволяет уникальным
образом определить отделение Получателя. Если отправка создается на отделение, и
отделение указано в виде Реф-идентификатора, передавать данные о городе
получателя нет необходимости.

"RecipientCityName": "Київ", - название города получателя на украинском языке


строкой согласно справочнику getSettlements
"RecipientArea": "", - - название области для города получателя на украинском языке
строкой согласно справочнику getSettlements
"RecipientAreaRegions": "", - название района для города получателя на украинском
языке строкой согласно справочнику getSettlements
"SettlementType": "", - тип населенного пункта на украинском языке строкой согласно
справочнику getSettlements

16
Параметры названия, области, района должны быть указаны на украинском языке в
точном соответствии со значениями, взятыми из справочника, загружаемого по
запросу getSettlements. Тип населенного пункта обязателен к заполнению для
случаев, если в одной области или районе есть два и более населенных пункта с
одинаковыми названиями, но разных типов (например, «село» и «селище міського
типу»).

"RecipientAddressName": "", -- значением данного параметра является название


улицы строкой на украинском языке, если доставка на адрес. Либо номер отделения,
если доставка на отделение, например «1».
"RecipientHouse": "", - номер дома Получателя, если доставка на адрес
"RecipientFlat": "",- номер квартиры Получателя, если доставка на адрес
"RecipientType": "PrivatePerson", -- тип Получателя, в данном примере Частное лицо
"RecipientName": "Петро Іванович Петренко", - имя Получателя
"RecipientContactName": "Петро Іванович Петренко", - имя контактного лица
Получателя (для частного лица параметры RecipientName и RecipientContactName
совпадают).

"RecipientsPhone": "380997979789" – номер телефона получателя

Дополнительные параметры

"NewAddress": "1", - данный параметр является обязательным, со значением «1» он


указывает на то, что в запросе на создание накладной используются данные о городе
получателя согласно справочнику getSettlements, и данные о Получателе передаются
в виде строк.

"DateTime":"" – дата создания отправки. Если этот параметр не будет заполнен,


автоматически будет использоваться текущая дата.

"PayerType": "Sender", -- значение данного параметра указывает, кто является


плательщиком за услуги доставки, предоставляемые Новой Почтой (Sender –
плательщиком является отправитель, «Recipient» - услуги доставки оплачивает
Получатель)

"PaymentMethod": "Cash", -- значение данного параметра указывает, за наличный


расчет (Cash) или по безналу (NonCash) будут оплачены услуги доставки,
предоставляемые Новой Почтой. Необходимо обратить внимание на то, что
безналичный расчет доступен контрагентам согласно соответствующим условиям
договора, заключенного с Новой Почтой.

"ServiceType": "WarehouseWarehouse", - значение данного параметра указывает на


тип доставки. Возможны следующие значения: WarehouseWarehouse – доставка с

17
отделения на отделение НП; WarehouseDoors – доставка с отделения на адрес;
DoorsWarehouse – доставка от адреса на отделение; DoorsDoors – доставка с адреса
на адрес.

"CargoType": "Parcel", - тип груза, возможные значения: Parcel – до 30 кг, Cargo –


свыше 30 кг, Pallet – паллета, Documents – документы (вес может быть 0,1, 0,5 или 1
кг).

"VolumeGeneral": "", - объем груза, в куб.м.

"Weight": "5", - вес в кг

"InfoRegClientBarcodes": "", - значением данного параметра является внутренний


номер заказа Клиента, это необязательный параметр.

"SeatsAmount": "1", - количество мест по накладной

"Description": "Техніка", - описание груза.

"AdditionalInformation": "", - дополнительная информация об отправлении, это


необязательный параметр.

"Cost": "100", - объявленная стоимость груза.

"AfterpaymentOnGoodsCost": "100" – Контроль оплаты (COD), данная финансовая


услуга предоставляется согласно договору с ПостФинанс. Значением этого параметра
является сумма денежных средств, которая будет получена от Получателя и
перечислена на расчетный счет Отправителя. Плательщиком за услугу «Контроль
оплаты» является Отправитель.

Описания других параметров, которые могут быть использованы в АПИ-запросе на


создание накладной, например, для заказа дополнительных услуг или для создания
отправки на Получателя-юридическое лицо (организацию), будут предоставлены
отдельно при необходимости.

Несколько примеров АПИ-запросов на создание накладных см. ниже.

Обратите внимание на то, что в примерах запросов используются произвольные


данные. При тестировании запросов, необходимо подставить в запрос
соответствующие значения из справочников.

В приведенных примерах используется тип доставки от Отделения Новой почты.


Точка входа для запросов в формате json - https://api.novaposhta.ua/v2.0/json/

1) Пример АПИ-запроса на создание накладной на отделение (указание


отделения в виде реф-идентификатора)

18
"apiKey": "fa10a61f0eb111ae306c6801923c111d",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"CitySender": "db5c88f0-391c-11dd-90d9-001a92567626",
"Sender": "8d411ce5-cae2-11e8-8b24-005056881c6b",
"SenderAddress": "0d545f59-e1c2-11e3-8c4a-0050568002cf",
"ContactSender": "d9dcbe11-cc88-11e8-8b24-005056881c6b",
"SendersPhone": "380501234567",
"RecipientWarehouseRef": " 5a39e553-e1c2-11e3-8c4a-0050568002cf",
"RecipientType": "PrivatePerson",
"RecipientName": "Петро Іванович Петров",
"RecipientContactName": "Петро Іванович Петров",
"RecipientsPhone": "380991234567",
"NewAddress": "1",
"DateTime":"12.03.2020",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"CargoType": "Parcel",
"VolumeGeneral": "0,02",
"Weight": "5",
"ServiceType": "WarehouseWarehouse",
"InfoRegClientBarcodes": "",
"SeatsAmount": "1",
"Description": "Техніка",
"AdditionalInformation": "",
"Cost": "100",
"AfterpaymentOnGoodsCost": "100"
}
}

2) Пример АПИ-запроса на создание накладной на адрес (указание города


Получателя в виде реф-идентификатора)

{
"apiKey": " fa10a61f0eb111ae306c6801923c111d",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"CitySender": "db5c88f0-391c-11dd-90d9-001a92567626",
"Sender": "8d411ce5-cae2-11e8-8b24-005056881c6b",
"SenderAddress": "0d545f59-e1c2-11e3-8c4a-0050568002cf",

19
"ContactSender": "d9dcbe11-cc88-11e8-8b24-005056881c6b",
"SendersPhone": "380501234567",
"RecipientCityRef": "cf8498bf-4f80-11e4-ab6d-005056801329",
"RecipientAddressName": "Шевченка",
"RecipientHouse": "9",
"RecipientFlat": "1",
"RecipientType": "PrivatePerson",
"RecipientName": "Петро Іванович Петров",
"RecipientContactName": "Петро Іванович Петров ",
"RecipientsPhone": "3801234567",
"NewAddress": "1",
"DateTime":"12.03.2020",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"CargoType": "Parcel",
"VolumeGeneral": "0,02",
"Weight": "5",
"ServiceType": "WarehouseDoors",
"InfoRegClientBarcodes": "",
"SeatsAmount": "1",
"Description": "Техніка",
"AdditionalInformation": "",
"Cost": "100",
"AfterpaymentOnGoodsCost": "100"
}
}

3) Пример АПИ-запроса на создание накладной на адрес (указание города


Получателя в виде строчных значений параметров)

{
"apiKey": "fa10a61f0eb111ae306c6801923c111d",
"modelName": "InternetDocument",
"calledMethod": "save",
"methodProperties": {
"CitySender": "db5c88f0-391c-11dd-90d9-001a92567626",
"Sender": "8d411ce5-cae2-11e8-8b24-005056881c6b",
"SenderAddress": "0d545f59-e1c2-11e3-8c4a-0050568002cf",
"ContactSender": "d9dcbe11-cc88-11e8-8b24-005056881c6b",
"SendersPhone": "380501234567",
"RecipientCityName": "Кононівка",
"RecipientArea": "Черкаська",

20
"RecipientAreaRegions": "Драбівський",
"SettlementType": "село",
"RecipientAddressName": "Нова",
"RecipientHouse": "1",
"RecipientFlat": "",
"RecipientType": "PrivatePerson",
"RecipientName": "Петро Іванович Петров",
"RecipientContactName": "Петро Іванович Петров",
"RecipientsPhone": "380991234567",
"NewAddress": "1",
"DateTime":"12.03.2020",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"CargoType": "Parcel",
"VolumeGeneral": "0,02",
"Weight": "5",
"ServiceType": "WarehouseDoors",
"InfoRegClientBarcodes": "",
"SeatsAmount": "1",
"Description": "Техніка",
"AdditionalInformation": "",
"Cost": "100",
"AfterpaymentOnGoodsCost": "100"
}
}

Другие примеры запросов, а также примеры запросов в формате xml, могут быть
предоставлены отдельно при необходимости.

Пример ответа на запрос создания накладной

В результате успешного выполнения запроса на создание накладной, в ответе


возвращаются следующие данные:
{
"success": true,
"data": [
{
"Ref": "5a9fc8e1-643e-11ea-8513-b88303659df5", -- реф-
идентификатор созданного документа (накладной)
"CostOnSite": 55, - стоимость услуг доставки
"EstimatedDeliveryDate": "13.03.2020", - ориентировочная дата
доставки

21
"IntDocNumber": "20450213886086", - номер созданного
документа (накладной)
"TypeDocument": "InternetDocument"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}

Создание накладной на почтомат НП


Для того чтобы создать накладную на почтомат "Нова Пошта", в АПИ запрос по
методу «save», модель «InternetDocument», необходимо обязательно добавить блок
данных OptionsSeat с описанием параметров (габаритов) посылки. Все остальные
параметры апи-запроса для создания накладной остаются без изменений, запрос
формируется аналогично как для отправки на любое отделение Новой Почты.

Ограничения:

Почтомат может быть только отделением получателя. Тип доставки в параметре


ServiceType должен быть указан как WarehouseWarehouse (с отделения на
отделение(почтомат)) или DoorsWarehouse (от дверей на отделение (почтомат)).

Отправлять на почтомат можно только типы груза - Посылка (CargoType=Parcel, вес


не более 20 кг) и Документы (CargoType=Documents, возможные значения веса (в
параметре Weight) – 0,1 или 0,5 или 1 кг ).

При создании отправления на почтомат, можно указывать только одно место на одно
отправление (параметр SeatsAmount cо значением 1).

Максимальное значение оценочной стоимости (параметр Cost) – 6000 грн.

Максимально допустимые габариты груза: ширина 40 см, длина 60 см, высота 30 см.

Пример блока данных габаритов посылки

"OptionsSeat": [

"weight": "5", -- вес в кг

"volumetricWidth":"10", - ширина в см, максимальное значение 40

"volumetricHeight":"10", - высота в см, максимальное значение 30

22
"volumetricLength":"10" - длина в см, максимальное значение 60

Полные примеры апи-запросов для создания отправок на почтомат могут быть


предоставлены отдельно при необходимости.
Редактирование созданной накладной
Созданную накладную (интернет-документ) можно редактировать, используя метод
«update», (работает в модели «InternetDocument»).

Важно: Редактирование интернет-документа возможно только до вывода его на


печать. Редактирование интернет-документа возможно только до передачи его
представителям Новой Почты для фактической отправки груза.

В апи-запросе для редактирования необходимо указать Реф-идентификатор


созданной накладной (интернет-документа) и все те же параметры, которые
использовались в запросе по методу save. При этом значения некоторых параметров
могут быть изменены согласно необходимости. В результате успешного выполнения
запроса в документе будут записаны внесенные изменения. В ответе на запрос
содержится тот же реф-идентификатор документа и предупреждения об измененных
параметрах.

После вывода отредактированной накладной или маркировки на печать


рекомендуется проверить правильность отображения на печатной форме всех
данных об отправлении.
Пример АПИ-запроса для редактирования накладной (интернет-документа)

{
"apiKey": "fa11a61f0eb111ae306c6801923c111d",
"modelName": "InternetDocument",
"calledMethod": "update",
"methodProperties": {
"Ref": "0a399341-68f4-11ea-8513-b88303659df5", -- реф-идентификатор созданного
документа
"CitySender": "db5c88f0-391c-11dd-90d9-001a92567626",
"Sender": "8d111ce5-cae2-11e8-8b24-005056881c6b",
"SenderAddress": "0d545f59-e1c2-11e3-8c4a-0050568002cf",
"ContactSender": "d9dcbe00-cc88-11e8-8b24-005056111c6b",
"SendersPhone": "380501234567",
"RecipientCityName": "Київ",
"RecipientArea": "",

23
"RecipientAreaRegions": "",
"SettlementType": "",
"RecipientAddressName": "3003",
"RecipientType": "PrivatePerson",
"RecipientName": "Петро Іванович Іванов",
"RecipientContactName": "Петро Іванович Іванов",
"RecipientsPhone": "380997979789",
"NewAddress": "1",
"DateTime":"18.03.2020",
"PayerType": "Sender",
"PaymentMethod": "Cash",
"CargoType": "Parcel",
"VolumeGeneral": "",
"Weight": "0.5",
"ServiceType": "WarehouseWarehouse",
"InfoRegClientBarcodes": "",
"SeatsAmount": "1",
"Description": "описание товара",
"AdditionalInformation": "",
"Cost": "1000",
"AfterpaymentOnGoodsCost": "",
"OptionsSeat": [
{
"weight": "0,5",
"volumetricWidth":"15",
"volumetricHeight":"10",
"volumetricLength":"10"
}
]
}
}
Пример ответа
{
"success": true,
"data": [
{
"Ref": "0a399341-68f4-11ea-8513-b88303659df5", - реф-
идентификатор документа (остается без изменений)
"CostOnSite": 45,
"EstimatedDeliveryDate": "19.03.2020",
"IntDocNumber": "20450215534976", - номер документа
(остается без изменений)
"TypeDocument": "InternetDocument"
}
],
"errors": [],

24
"warnings": [
"VolumeWeight is changed",
"VolumeGeneral is changed",
"Weight is changed"
],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [
"30000200888",
"30000200889",
"30000200881"
],
"infoCodes": []
}

В приведенном выше примере апи-запроса использовались произвольные данные.


Другие примеры запросов, а также примеры запросов в формате xml могут быть
предоставлены отдельно при необходимости.

Работа с реестрами

Для передачи созданных отправлений представителям Новой Почты необходимо


сформировать реестр накладных и распечатать его в двух экземплярах, и для каждого
отправления (по каждому номеру накладной) распечатать маркировку.
Сформировать реестр отправлений можно в Личном кабинете либо с помощью АПИ-
запроса. В ответ на запрос формирования реестра возвращается номер реестра и номера
отправлений со статусом "добавлено" или "не добавлено" в реестр.
Пример АПИ-запроса для добавления документов в новый реестр
{ "apiKey" : "ваш ключ",
"modelName" : "ScanSheet",
"calledMethod" : "insertDocuments",
"methodProperties" : {
"DocumentRefs" : [
"7f3bf6ff-6f58-11ea-8513-b88303650df5" -- реф-идентификатор или номер документа
] }}
Пример ответа на запрос добавления документов в реестр
{
"success": true,
"data": [
{

25
"Ref": "9e5c5270-6f58-11ea-8513-b88303650df5", - реф
идентификатор созданного реестра
"Number": "105-11616927", - номер созданного реестра
"Date": "2020-03-26 13:54:59", - дата и время создания
реестра
"Description": "",
"Errors": [],
"Success": [
{
"Ref": "7f3bf6ff-6f58-11ea-8513-b88303659df5",
- реф идентификатор документа, добавленного в реестр
"Number": "20450217866047" – номер документа,
добавленного в реестр
}
],
"Warnings": [],
"Data": {
"Errors": [],
"Success": [],
"Warnings": []
}
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []}
Также, документ может быть добавлен в существующий реестр, пример запроса:
{ "apiKey" : " fa11a61f1eb144ae306c6801923c124d",
"modelName" : "ScanSheet",
"calledMethod" : "insertDocuments",
"methodProperties" : {
"Ref" : "6d4e3fde-db61-11e8-8b24-005056881c6b", -- реф или номер реестра
"DocumentRefs" : [
"5ed9e40f-db61-11e8-8b24-005056881c6b" -- реф или номер документа для добавления в
реестр
]
}
}
Пример АПИ-запроса для получения информации по одному реестру
{
"modelName": "ScanSheet",

26
"calledMethod": "getScanSheet",
"methodProperties": {
"Ref": "105-04954010" – реф идентификатор или номер реестра
},
"apiKey": " ваш ключ "
}
В ответе возвращается информация по всем накладным, включенным в реестр.
Пример АПИ-запроса для получения списка реестров
{
"modelName": "ScanSheet",
"calledMethod": "getScanSheetList",
"apiKey": " fa11a61f1eb144ae306c6801923c124d"
}
В ответе возвращается информация обо всех реестрах, созданных в данном аккаунте.
Пример АПИ-запроса для удаления (расформирования) реестра отправлений
Если реестр был создан, но по какой-то причине не будет использоваться, его можно
удалить. После удаления реестра, из информационной системы "Новая Почта" удаляется
номер реестра, а экспресс-накладные, которые были включены в него, исключаются из
реестра, но не удаляются (происходит расформирование реестра). Для удаления реестра
необходимо сформировать соответствующий запрос.

"modelName": "ScanSheet",

"calledMethod": "deleteScanSheet",

"methodProperties": {

"ScanSheetRefs": [

"105-04536404" -- реф или номер реестра

},

"apiKey": "ваш ключ "

}
В результате успешного выполнения запроса, в ответе возвращается информация об
удаленном реестре:

27
{
"success": true,
"data": {
"ScanSheetRefs": {
"Errors": [],
"Success": [
{
"Ref": "1fa06b9f-6f59-11ea-8513-b88303659df5",
- реф-идентификатор реестра
"Number": "105-11617067" – номер реестра
}
]
}
},…

Пример АПИ-запроса для удаления экспресс-накладных из реестра


Если накладные были добавлены в реестр по ошибке, то их можно удалить из реестра. В
запросе необходимо передать реф-идентификатор или номер документа, подлежащего
удалению из реестра. В результате успешного выполнения запроса, документ удаляется
только из реестра, но сохраняется в Вашем аккаунте.

"modelName": "ScanSheet",

"calledMethod": "removeDocuments",

"methodProperties": {

"DocumentRefs": [

"20450217866247" – реф –идентификатор или номер документа

},

"apiKey": "ваш ключ"

}
Ограничения при работе с реестрами
При работе с реестрами необходимо обратить внимание на существующие ограничения, а
именно:
1) В реестр можно добавить интернет документ (накладную), если данные Отправителя
(город, контрагент, адрес) идентичны для всех отправлений, добавляемых в реестр.
2) ИД можно добавить только в один реестр. Т.е. один и тот же документ не может
быть добавлен одновременно в несколько реестров.
3) В реестр нельзя добавить ИД, который был распечатан более суток тому назад

28
(дата печати меньше вчерашней по сравнению с датой формирования реестра).
4) ИД можно добавить в реестр только до момента создания экспресс-накладной на
основе ИД (т.е. до проведения сканировки данного отправления в отделении НП)
5) В реестр нельзя добавить накладную (интернет-документ), помеченный на
удаление.
6) После получения печатной формы реестра добавление документов в него
блокируется.
Рекомендуемое максимальное количество накладных в одном реестре – 200.
Получение печатной формы реестра
Получить печатную форму реестра можно с помощью GET-запроса по номеру или РЕФ-
идентификатору реестра. В приведенные ниже запросы необходимо подставить реф-
идентификатор или номер реестра и Ваш API-ключ.

Пример запроса для печати реестра по ref-идентификатору реестра


https://my.novaposhta.ua/scanSheet/printScanSheet/refs[]/7ed08016-89e6-11e5-a70c-
005056801333/type/pdf/apiKey/ВАШ АПИ-КЛЮЧ

Пример запроса для печати реестра по номеру реестра


https://my.novaposhta.ua/scanSheet/printScanSheet/refs[]/105-00000595/type/pdf/apiKey/ВАШ
АПИ КЛЮЧ

Получение печатных форм экспресс-накладных и маркировок


Получение печатной формы экспресс-накладной
Получить файл для печати по номеру или реф-идентификатору накладной.

1. Печать из браузера

Печать по Ref –идентификатору накладной, get-запрос

https://my.novaposhta.ua/orders/printDocument/orders[]/ab91865b-2937-11e4-ab6d-
005056801329/orders[]/ab91865b-2937-11e4-ab6d-005056801329/type/pdf/apiKey/[ВАШ КЛЮЧ]

Вместо Ref можно передавать номер ЕН:

Печать по Номеру накладной, get-запрос


https://my.novaposhta.ua/orders/printDocument/orders[]/20600000002260/type/pdf/apiKey/[ВАШ
КЛЮЧ]

2. Печать нескольких ТТН с помощью одного запроса


https://my.novaposhta.ua/orders/printDocument/orders/20600000002310,20600000002309/type/pdf/a
piKey/[ВАШ КЛЮЧ]

Получение печатных форм маркировок


Получить файл для печати маркировок можно по номеру или реф-идентификатору накладной.
Маркировка размещается на каждом месте отправления, если Клиент осуществляет прием-
передачу отправлений по реестру.

29
Печать маркировок на принтере Zebra

https://my.novaposhta.ua/orders/printMarking100x100/orders[]/ab91865b-2937-11e4-ab6d-
005056801329/type/pdf/apiKey/ВАШ КЛЮЧ/zebra
Вместо Ref в запросе можно передавать номер ЕН

Печать нескольких маркировок по Ref на принтере Zebra


https://my.novaposhta.ua/orders/printMarking100x100/orders/e3ffb9a6-a7d8-11e9-9937-
005056881c6b,e3ffb9a6-a7d8-11e9-9937-005056881c6b/type/pdf/zebra/zebra/apiKey/ВАШ КЛЮЧ
Вместо Ref в запросе можно передавать номер ЕН

Трекинг
Метод «getStatusDocuments», работает в модели «TrackingDocument» и позволяет получить
расширенную информацию об отправлении и его статусе на данный момент времени. Метод
позволяет просматривать одновременно до 100 отправлений.

Пример API-запроса для трекинга отправлений

{
"apiKey": "ВАШ КЛЮЧ]",
"modelName": "TrackingDocument",
"calledMethod": "getStatusDocuments",
"methodProperties": {
"Documents": [
{
"DocumentNumber": "номер накладной",
"Phone":"номер телефона отправителя или получателя, необязательно"
},
{
"DocumentNumber": "номер накладной",
"Phone":" номер телефона отправителя или получателя, необязательно "
}
]
}

Актуальные статусы трекинга

Код Статус

1 Нова пошта очікує надходження від відправника

30
2 Видалено

3 Номер не знайдено

4 Відправлення у місті Відправника.

41 Відправлення у місті Відправника. (Статус для услуг локал стандарт и локал экспресс -
доставка в пределах города)

5 Відправлення прямує до міста Отримувача.

6 Відправлення у місті Отримувача, орієнтовна доставка до ВІДДІЛЕННЯ-XXX dd-mm.

Очікуйте додаткове повідомлення про прибуття.

7, 8 Прибув на відділення

9 Відправлення отримано

10 Відправлення отримано %DateReceived%.Протягом доби ви одержите SMS-повідомлення


про надходження грошового переказу та зможете отримати його в касі відділення «Нова пошта».

11 Відправлення отримано %DateReceived%. Грошовий переказ видано одержувачу.

14 Відправлення передано до огляду отримувачу

101 На шляху до одержувача

102, 103, 108 Відмова одержувача

104 Змінено адресу

105 Припинено зберігання

106 Одержано і створено ЕН зворотньої доставки

Дополнительная информация и примеры API-запросов могут быть предоставлены по


запросу Клиента. Также, информация о работе с APІ Новой почты представлена на
Портале для разработчиков https://devcenter.novaposhta.ua/

31
32

Вам также может понравиться