1. Личный кабинет API 2 Home

1. Личный кабинет API 2 Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1 Оформление отправлений . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.2 Печать документов . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.3 Методы . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

1.3.1 InternetDocument - Модель для оформления отправлений . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.3.1.1 save() - создание ЭН . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.3.1.2 update() - редактирование ЭН . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.3.1.3 delete() - удаление документа . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.3.1.4 getDocumentPrice - расчет стоимости доставки . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.3.1.5 getDocumentDeliveryDate - ориентировочная дата доставки . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.3.1.6 getDocument() - получить ЭН . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181.3.1.7 getDocumentList() - получает список ЭН . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181.3.1.8 printDocument() - печать ЭН . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.3.1.9 printMarkings() - печать маркировок . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.3.1.10 documentsTracking() - трекинг документов . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.3.1.11 generateReport() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.3.2 Common - Модель для работы со справочниками . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231.3.2.1 getBackwardDeliveryCargoTypes() - получить список видов обратной доставки груза . . . . . . . . . . . . . . . . . . 231.3.2.2 getCargoDescriptionList() - загрузить справочник описания груза . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.3.2.3 getCargoTypes() - загрузить список видов груза . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251.3.2.4 getDocumentStatuses() - загрузить список статусов документов . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261.3.2.5 getOwnershipFormsList() - загрузить список форм собственности . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.3.2.6 getPalletsList() - загрузить список поддонов (при заказе услуги обратная доставка поддонов) . . . . . . . . . . . 321.3.2.7 getPaymentForms() - загрузить список форм оплаты . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321.3.2.8 getServiceTypes() - загрузить справочник технологий доставки . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331.3.2.9 getTimeIntervals() - загрузить список временных интервалов (для заказа услуги "Временные интервалы") . 34341.3.2.10 getTiresWheelsList() - загрузить список шин и дисков (если вид груза "шины-диски") . . . . . . . . . . . . . . . . . 351.3.2.11 getTraysList() - загрузить список поддонов (если заказана услуга обратной доставки поддонов) . . . . . . . 391.3.2.12 getTypesOfCounterparties() - загрузить список типов контрагентов отправителей . . . . . . . . . . . . . . . . . . . . 391.3.2.13 getTypesOfPayers() - загрузить список видов плательщиков . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401.3.2.14 getTypesOfPayersForRedelivery() - загрузить список видов плательщиков обратной доставки . . . . . . . . . . 41

1.3.3 Counterparty - Модель для работы с данными контрагента . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421.3.3.1 save() - сохранить контрагента . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431.3.3.2 saveThirdPerson() - сохранить контрагента с типом "третье лицо" . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.3.3.3 update() - обновить данные контрагента . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.3.3.4 updateThirdPerson() - обновить данные контрагента с типом "третье лицо" . . . . . . . . . . . . . . . . . . . . . . . . . . 451.3.3.5 delete() - удалить контрагента отправителя/получателя . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451.3.3.6 cloneLoyaltyCounterpartySender() - создать контрагента-отправителя в выбранном городе (для участников

программы лояльности) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451.3.3.7 getCounterparties() - загрузить список контрагентов отправителей/получателей . . . . . . . . . . . . . . . . . . . . . . 451.3.3.8 getCounterpartyAddresses() - загрузить список адресов контрагентов . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451.3.3.9 getCounterpartyContactPersons() - загрузить список контактных лиц контрагента . . . . . . . . . . . . . . . . . . . . . 461.3.3.10 getCounterpartyByEDRPOU() - найти контрагента по коду ОКПО . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461.3.3.11 getCounterpartyOptions() - загрузить параметры контрагента . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

1.3.4 ContactPerson - Модель для создания контактного лица . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461.3.4.1 save() - сохранить данные контактного лица отправителя/получателя . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471.3.4.2 update() - обновить данные контактного лица . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471.3.4.3 delete() - удалить контактное лицо отправителя/получателя . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

1.3.5 Address - Модель для работы с адресами . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481.3.5.1 save() - создать адрес отправителя/получателя . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481.3.5.2 update() - редактировать адрес отправителя/получателя . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481.3.5.3 delete() - удалить ранее созданный адрес . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491.3.5.4 getCities() - загрузить справочник городов компании «Новая Почта» . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491.3.5.5 getStreet() - загрузить справочник улиц компании «Новая Почта» . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501.3.5.6 getWarehouses() - загрузить справочник отделений компании «Новая Почта» . . . . . . . . . . . . . . . . . . . . . . . 511.3.5.7 getAreas() - загрузить справочник географических областей Украины . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511.3.5.8 findNearestWarehouse - поиск ближайшего склада по текстовому представлению адреса . . . . . . . . . . . . . . 52

1.3.6 ScanSheet - Модель для работы с реестрами приема-передачи отправлений . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531.3.6.1 insertDocuments() - добавить экспресс-накладные в реестр . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541.3.6.2 removeDocuments() - удалить экспресс-накладные из реестра . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541.3.6.3 deleteScanSheet() - удалить (расформировать) реестр отправлений . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551.3.6.4 printScanSheet() - загрузка печатной формы реестра . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561.3.6.5 getScanSheet() - загрузить информацию по одному реестру . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561.3.6.6 getScanSheetList() - загрузить список реестров . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

1.3.7 LoyaltyUser - Модель для работы с данными участника программы лояльности . . . . . . . . . . . . . . . . . . . . . . . . . . . 571.3.7.1 generateReport() - загрузить отчет "оборот по карте программы лояльности" в формате xls или csv . . . . . 571.3.7.2 getLoyaltyCardDetails() - загрузить информацию по карте участника программы лояльности . . . . . . . . . . . 581.3.7.3 getLoyaltyCardTurnover() - загрузить информацию по обороту баллов на карте участника программы

лояльности . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581.3.8 ArchiveRequest - Модель для работы с архивами экспресс-накладных . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

1.3.8.1 save() - создание заявки . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581.4 Термины и сокращения . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Личный кабинет API 2 HomeДля быстрого оформления большого количества отправлений, используется способ электронного обмена данными междуинформационной системой компании «Новая Почта» и программным комплексом Партнера/Клиента. Обмен даннымиосуществляется путем передачи информации в виде файлов в формате JSON через программную среду АРІ.

Для начала работы с функционалом АРІ компании «Новая Почта» необходимо создать ключ на странице настройки в личномкабинете . Ключ АРІ обязательно включается в каждый файл при формировании запроса. my.novaposhta.uaВажно! Все создаваемые ключи ограничены во времени действия, настоятельно рекомендуем учитывать данное ограничение.

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

Точка входа для сервисов в формате XML https://api.novaposhta.ua/v2.0/xml/

Точка входа для сервисов в формате JSON-RPC2 https://api.novaposhta.ua/v2.0/jsonrpc2

Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?https://api.novaposhta.ua/v2.0/json/

Точка входа для сервисов в формате JSON-RPC2 с форматом ответа JSONP ?callback=?https://api.novaposhta.ua/v2.0/jsonrpc2/

ОПИСАНИЕ ОБЩИХ ПАРАМЕТРОВ

Запрос

* apiKey ключ API (направляется при регистрации пользователя)

* modelName имя модели

* calledMethod имя вызываемого метода

methodProperties свойство метода, для всех методов

* Обозначение обязательного параметра

Ответ

success true - при удачном запросе, false – если возникла ошибка

data параметры с данными

errors ошибка

warnings предупреждение

info информация

Структура файла-запроса и ответа на запрос

Пример запроса JSON Пример ответа JSON

{

" ": "ключ API пользователя",apiKey

" ": "[имя модели]",modelName

" ": "[имя вызываемого метода]",calledMethod

" ": {methodProperties

"[свойство1]": "...",

"[свойство2]": "..."

}

}

{

" ": true,success

" ": [data

{

"[свойство1]": "...",


}

],

" ": [ ],errors

" ": [ ],warnings

" ": [ ]info

}

https://my.novaposhta.ua/settings/index#apikeys

https://api.novaposhta.ua/v2.0/json/

https://api.novaposhta.ua/v2.0/xml/

https://api.novaposhta.ua/v2.0/jsonrpc2





Пример запроса XML Пример ответа XML

<? version="1.0" encoding="utf-8"?>xml

< >file

< >ключ API пользователя</ >apiKey apiKey

< >имя модели</ >modelName modelName

< >имя вызываемого метода</ >calledMethod calledMethod

< >methodProperties

<свойство1>...</свойство1>


</methodProperties>

</ >file

<?xml version="1.0" encoding="UTF-8"?>

<root>

< >true</ >success success

< >data

< >item




</ >item

</ >data

< />errors

< />warnings

< />info

</root>

Пример запроса XML, если принимаем массив

<? version="1.0" encoding="utf-8"?>xml

< >file

< >ключ API пользователя</ >apiKey apiKey

< >имя модели</ >modelName modelName

< >имя вызываемого метода</ >calledMethod calledMethod

< >methodProperties

<parameter>

<item>...</item>

<item>...</item>

<parameter>

</methodProperties>

</ >file

Пример запроса JSON-RPC2 Пример ответа JSON-RPC2

{

"jsonrpc":"2.0",

"method":" ",имя модели.имя вызываемого метода

"params":{

" ":{ methodProperties

"свойство1":"...",

"свойство2":"..."

},

" ":"ключ API пользователя"apiKey

},

"id":"..."

}

{ "jsonrpc": "2.0", "result": [ { "свойство1": ..., "свойство2": "...", "свойство3": "..." }, { "свойство1": ..., "свойство2": "...", "свойство3": "..." } ], "id": "...", "warnings": [], "info": []}

Пример множественного запроса JSON-RPC2 Пример множественного ответа JSON-RPC2

[

{

"jsonrpc":"2.0",


"params":{




},


},

"id":"..."

},

{

"jsonrpc":"2.0",


"params":{




},


},

"id":"..."

}

]

[{ "jsonrpc": "2.0", "result": [ { "свойство1": ..., "свойство2": "...", "свойство3": "..." }, { "свойство1": ..., "свойство2": "...", "свойство3": "..." } ], "id": "...", "warnings": [], "info": []},

{ "jsonrpc": "2.0", "result": [ { "свойство1": ..., "свойство2": "...", "свойство3": "..." }, { "свойство1": ..., "свойство2": "...", "свойство3": "..." } ], "id": "...", "warnings": [], "info": []}

]

Пример ответа с форматом ответа JSONPJSON

Точка входа https://api.novaposhta.ua/v2.0/json/?callback=?

Пример точки входа с get параметром callback https://api.novaposhta.ua/v2.0/json/?callback=call6556553322



Запрос {

" ": "ключ API пользователя",apiKey

" ": "[имя модели]",modelName

" ": "[имя вызываемого метода]",calledMethod


"[свойство1]": "...",


}

}

Ответ call6556553322(

{

" ": true,success

" ": [data

{

"[свойство1]": "...",


}

],

" ": [ ],errors

" ": [ ],warnings

" ": [ ]info

}

)

Пример ответа JSON-RPC2 с форматом ответа JSONP

Точка входа https://api.novaposhta.ua/v2.0/jsonrpc2/?callback=?

Пример точки входа с get параметром callback https://api.novaposhta.ua/v2.0/jsonrpc2/?callback=call6556553323

Запрос {

"jsonrpc":"2.0",


"params":{




},


},

"id":"..."

}







1. 2. 3. 4.

a. b.

5. 6. 7. 8. 9.

10. 11.

a. b.

12.

1.

Ответ call6556553323(

{ "jsonrpc": "2.0", "result": [ { "свойство1": ..., "свойство2": "...", "свойство3": "..." }, { "свойство1": ..., "свойство2": "...", "свойство3": "..." } ], "id": "...", "warnings": [], "info": [] }

)

Оформление отправленийДля оформления отправления из информационной системы Клиента направляется файл-запрос на формированиеэкспрес-накладной, который содержит данные Отправителя, Получателя, информацию об отправлении, информацию о заказедополнительных услуг (при необходимости). В ответ на запрос, информационная система "Новая Почта" направляет номерэкспресс-накладной и сохраняет документ (экспресс-накладную) в личном кабинете Клиента на сайте компании "Новая Почта".

Для формирования запроса на создание экспресс-накладной, необходимо выполнить следующие действия:

Загрузить справочник городов компании «Новая Почта»Загрузить справочник «тип контрагента»Загрузить справочник возможных плательщиков услуг доставкиСоздать контрагента-Получателя отправления

Контрагент-Получатель – физическое лицоКонтрагент-Получатель – юридическое лицо

Загрузить справочник возможных контрагентов-отправителей Клиента (если ранее контрагенты были созданы Клиентом)Создать контрагента-Отправителя в выбранном городеЗагрузить справочник возможных способов оплатыЗагрузить справочник видов грузаЗагрузить справочник технологий доставкиЗагрузить справочник описания грузаЗагрузить справочник адресов

Если отправление адресовано "до отделения" или "от отделения"Если отправление адресовано "до двери или" или "от двери"

Сформировать запрос на создание экспресс-накладной

Печать документовПечать экспрес-накладныхПечать экспресc-накладных, используется в случае, если Клиент которые не передают отправления по реестру.Необходимо печатать 4 экземпляра печатных форм экспресс-накладных.

2 экземпляра размещается на первом месте отправления (если в отправлении больше 1 места, на всех последующихместах размещается маркировка),

1.

a. b.

2.

a. b. c. d.

3.

местах размещается маркировка),

2 экземпляра экспресс-накладных подписываются в процессе приема-передачи отправлений

Печать из браузераПечать в формате pdf

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

Печать из браузераПечать в формате pdfПечать на принтере для печати штрих-кодов (Zebra) - функционал в разработкеПечать несколько маркировок в одном запросе - функционал в разработке

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

Методы

InternetDocument - Модель для оформления отправленийМодель InternetDocument, с помощью которой возможно:

создавать экспресс-накладныередактировать данные в созданных экспресс-накладные (до передачи отправления)удалять/отменять созданные экспресс-накладные (до передачи отправления)выгружать данные в формате XLS и CSVзагружать списки документов используя фильтры формировать печатные формы экспресс-накладных, маркировокзагрузить список статусов трекингаотслеживать статусы отправления

save() - создание ЭН

Формирование экспресс-накладной (интернет-документа)

Общий пример запроса для формированияэкспресс-накладной

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

{

"apiKey": " Ключ АРІ Клиента ",

"modelName": "InternetDocument",

"calledMethod": "save",

"methodProperties": {

"PayerType": "Sender",

"PaymentMethod": "Cash",

"DateTime": "12.05.2014",

"CargoType": "Cargo",

"VolumeGeneral": "10",

"Weight": "10",

"ServiceType": "WarehouseDoors",

"SeatsAmount": "1",

"Description": "абажур",

"Cost": "500",

"CitySender": "db5c88f5-391c-11dd-90d9-001a92567626",

"Sender": "4d87603b-c3bc-11e3-9fa0-0050568002cf",

"SenderAddress": "c9f591a1-a91a-11e3-9fa0-0050568002cf",

"ContactSender": "b2dd60db-c3a8-11e3-9fa0-0050568002cf",

"SendersPhone": "0937640250",

"CityRecipient": "d8ff4ee6-981a-11e1-9e32-0026b97ed48a",

"Recipient": "10cf99b4-d4f0-11e3-95eb-0050568046cd",

"RecipientAddress":"400d602d-d4f4-11e3-95eb-0050568046cd",

"ContactRecipient":"045246fc-d4f5-11e3-95eb-0050568046cd",

"RecipientsPhone": "0663456655"

}

}

{

"success": true,

"data": [

{

"Ref": "0336e668-d503-11e3-95eb-0050568046cd",

"CostOnSite": 76,

"EstimatedDeliveryDate": "15.05.2014",

"IntDocNumber": "20400000000011",

"TypeDocument": "InternetDocument"

}

],

"errors": [],

"warnings": [],

"info": []

}

№ Параметр Тип значения Описание Примечание

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

1 DateTime дата в формате:дд.мм.гггг

дата отправки обязательно длязаполнения

2 ServiceType значение изсправочника

Технология доставки обязательно длязаполнения

3 Sender код отправитель обязательно длязаполнения

4 CitySender код город отправителя обязательно длязаполнения

5 SenderAddress код адрес отправителя обязательно длязаполнения

6 ContactSender код контактное лицоотправителя

обязательно длязаполнения

7 SendersPhone телефон в формате: +3806600000003806600000000660000000

телефон отправителя обязательно длязаполнения

8 Recipient код получатель обязательно длязаполнения

9 CityRecipient код город получателя обязательно длязаполнения

10 RecipientAddress код адрес получателя обязательно длязаполнения

11 ContactRecipient код контактное лицополучателя


12 RecipientsPhone телефон в формате: +3806600000003806600000000660000000

телефон получателя обязательно длязаполнения

13 PaymentMethod значение изсправочника

форма оплаты обязательно длязаполнения

14 PayerType значение изсправочника

тип плательщика обязательно длязаполнения

15 Cost целое число объявленнаястоимость


16 SeatsAmount целое число количество местотправления


17 Description значение изсправочника

описание груза обязательно длязаполнения

18 CargoType значение изсправочника

тип груза обязательно длязаполнения

19 CargoDetails параметр для указаниявида груза"шины-диски" или"паллета"

обязательно длязаполнения, если типгруза (CargoType) -"Шини-диски" или"Палета"

20 CargoDescription код из справочника

21 Amount целое число

22 Weight min - 0,1 Вес фактический, кг обязательно длязаполнения

23 VolumeWeight расчетное значение вИС "Новая Почта"

вес объемный, кг не обязательное поле,если указаны значенияVolumeGeneral илиOptionsSeat

24 VolumeGeneral min - 0.0004 объем общий, м.куб обязательно длязаполнения, если неуказаны значенияOptionsSeat

25 OptionsSeat параметры груза длякаждого местаотправления

обязательно длязаполнения, если неуказано значениеVolumeGeneral

26 volumetricVolume min -0.0004 объем одного местаотправления, м.куб

27 volumetricWidth min - 5 ширина одного местаотправления, см

28 volumetricLength min - 5 длинна одного местаотправления, см

29 volumetricHeight min - 5 высота одного местаотправления, см

30 Pack вид упаковки необязательно длязаполнения

31 AdditionalInformation max - 100 символов дополнительнаяинформация оботправлении (любая,необходимая Клиентуинформация в ЭН)

необязательно длязаполнения

32 PackingNumber max - 10 символов возможность указать№ упаковки


33 AccompanyingDocuments

max - 50 символов сопровождающиедокументы


34 InfoRegClientBarcodes номер внутреннегозаказа Клиента (нехранится в ИС "НоваяПочта")


Услуги

1 BackwardDeliveryData Обратная доставка обязательно длязаполнения при необходимостизаказать услуги"Обратная доставка"

2 PayerType значение изсправочника

тип плательщикаобратной доставки

обязательно длязаполнения при необходимостизаказать услуги"Обратная доставка"

3 CargoType значение изсправочника

вид обратной доставки обязательно длязаполнения при необходимостизаказать услуги"Обратная доставка"

4 RedeliveryString значение изсправочника

описание видаобратной доставки

обязательно длязаполнения при необходимостизаказать услуги"Обратная доставка"

5 CreditDocuments значение изсправочника

он-лайн кредит вид обратной доставки

6 SignedDocuments значение изсправочника

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

вид обратной доставки

7 RedeliveryStringRub целое число сумма в руб. *параметр временно неиспользуетсяобязательно длязаполнения при необходимостизаказать услуги"Обратная доставкаценных бумаг в Крым"

8 ForwardingCount целое число экспедирование обязательно длязаполнения при необходимостизаказать услуги"Экспедирование"

9 AfterpaymentOnGoodsCost

сумма, целое число Контроль оплаты обязательно длязаполнения при необходимостизаказать услуги"Контроль оплаты"

10 PreferredDeliveryDate дата в формате:дд.мм.гггг

желаемая датадоставки

обязательно длязаполнения при необходимостизаказать услуги"желаемая датадоставки"

11 SameDayDelivery услуга заказана - 1услуга не заказана - 0

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

12 TimeInterval значение изсправочника

доставка во временныеинтервалы

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

13 IsTakeAttorney услуга заказана - 1услуга не заказана - 0

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

14 SaturdayDelivery услуга заказана - 1

услуга не заказана - 0

субботняя доставка

Пример запроса для формирования ЭН с типом груза "шины-диски"

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "CargoType": "TiresWheels", "CargoDetails": [ { "CargoDescription": "20f7b626-9add-11e3-b441-0050568002cf", "Amount": "2" } ] }, "apiKey": ""}

Пример запроса для формирования ЭН с типом груза "палети" или "вантаж" с указанием параметров каждого места

{ "modelName":"InternetDocument", "modelProperties":{}, "calledMethod":"save", "methodProperties":{ "CargoType":"Pallet", "OptionsSeat":[ { "volumetricVolume":"10", "volumetricWidth":"10", "volumetricLength":"10", "volumetricHeight":"10", "weight":"10" }, { "volumetricVolume":"10", "volumetricWidth":"10", "volumetricLength":"10", "volumetricHeight":"10", "weight":"10" } ] }, "apiKey":""}

Пример запроса с заказом услуги "доставка во временные интервалы"

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "TimeInterval":"CityDeliveryTimeInterval3" }, "apiKey": ""}

Пример запроса с заказом услуги "обратная доставка Ц1П"

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"Money", "RedeliveryString":"4552" } ] }, "apiKey": ""}

Пример запроса с заказом услуги "обратная доставка Ц2П" (если доставка в Крым, необходимо указывать сумму обратнойдоставки в руб.)

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"Money", "RedeliveryString":"4552", "RedeliveryStringRub": "400" } ] }, "apiKey": ""}

Пример запроса с заказом услуги "обратная доставка ЭН перевозчика" (5я ТТН)

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"EWTransporter", "RedeliveryString":" " } ] }, "apiKey": ""}

Пример запроса с заказом услуги "кредитные документы"

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"CreditDocuments", "RedeliveryString":" " } ] }, "apiKey": ""}

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

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"SignedDocuments", "RedeliveryString":" " } ] }, "apiKey": ""}

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

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"Trays", "RedeliveryString":"\u041fi\u0434\u0434\u043e\u043d\u0438( \u0442\u0430\u0440\u0430)", "Trays":[ { "CargoDescription":"d5c36c5c-a29d-11de-a2ca-000c294065a1", "Amount":"5" }, { "CargoDescription":"d5c36c5d-a29d-11de-a2ca-000c294065a1", "Amount":"3" } ] }, { "PayerType":"Sender", "CargoType":"Money", "RedeliveryString":"4552" } ] }, }, "apiKey": ""}

Пример запроса с заказом 2х видов обратной доставки

{ "modelName": "InternetDocument", "modelProperties": {}, "calledMethod": "save", "methodProperties": { "BackwardDeliveryData":[ { "PayerType":"Sender", "CargoType":"Money", "RedeliveryString":"4552" }, { "PayerType":"Sender", "CargoType":"Trays", "RedeliveryString":"\u041fi\u0434\u0434\u043e\u043d\u0438( \u0442\u0430\u0440\u0430)", "Trays":[ { "CargoDescription":"d5c36c5c-a29d-11de-a2ca-000c294065a1", "Amount":"5" }, { "CargoDescription":"d5c36c5d-a29d-11de-a2ca-000c294065a1", "Amount":"3" } ] } ] }, }, "apiKey": ""}

update() - редактирование ЭН

Метод: - обновление данных по ЭНupdate()

Параметр Описание

Ref Идентификатор документа

Все остальные параметры - как у метода save()

delete() - удаление документа

Метод: - удаление документаdelete()

Параметр Описание Значения

* DocumentRefs Массив идентификаторов удаляемыхдокументов

Т.к. есть нюансы в формате запроса и ответа xml, приводим пример:

Пример запроса xml

<?xml version="1.0" encoding="UTF-8"?><file> <apiKey>[ВАШ АПИ КЛЮЧ]</apiKey> <modelName>InternetDocument</modelName> <calledMethod>delete</calledMethod> <methodProperties> <DocumentRefs> <item>288af9a6-8509-11e4-8d2b-005056801329</item> </DocumentRefs> </methodProperties></file>

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

<?xml version="1.0" encoding="UTF-8"?><root> <success>true</success> <data> <item> <Ref>fced4429-8523-11e4-8d2b-005056801329</Ref> </item> </data> <errors /> <warnings /> <info /></root>

getDocumentPrice - расчет стоимости доставки

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

№ Параметр Тип значения Описание Примечание

1 CitySender Код город отправителя обязательно длязаполнения

2 CityRecipient Код город получателя обязательно длязаполнения

3 ServiceType Значение сосправочника

технология доставки обязательно длязаполнения

4 Weight вес фактический, кг обязательно длязаполнения

5 Cost объявленнаястоимость, грн


Все остальные параметры - не обязательные, такие же и в таком же формате, как в разделе .save() - создание ЭН

Запрос:

{ "modelName": "InternetDocument", "calledMethod": "getDocumentPrice", "methodProperties": { "CitySender": "8d5a980d-391c-11dd-90d9-001a92567626", "CityRecipient": "db5c88f0-391c-11dd-90d9-001a92567626", "Weight": 10, "Cost": 200, "ServiceType": "DoorsDoors" }}

Ответ:

{ "success": true, "data": [ { "Cost": 65 } ], "errors": [], "warnings": [ "DateTime is set to current" ], "info": []}

getDocumentDeliveryDate - ориентировочная дата доставки

Этот метод публичный, т.е. доступный без ключа авторизации.

Запрос:

{"modelName": "InternetDocument","calledMethod": "getDocumentDeliveryDate","methodProperties": {"DateTime": "30.08.2014","CitySender": "8d5a980d-391c-11dd-90d9-001a92567626","CityRecipient": "db5c88de-391c-11dd-90d9-001a92567626","ServiceType": "WarehouseDoors"} ,"apiKey": "[ВАШ АПИ КЛЮЧ]"}

Ответ:

{ "success": true, "data": [ { "DeliveryDate": { "date": "2014-11-10 00:00:00.000000", "timezone_type": 3, "timezone": "Europe/Kiev" } } ], "errors": [], "warnings": [ "DateTime is set to current" ], "info": []}

getDocument() - получить ЭН

Получает ЭН

Параметр Значение

Ref

getDocumentList() - получает список ЭН

Получает список ЭН

Параметр Значение

Ref Ref документа, используется при печати через API

IntDocNumber

InfoRegClientBarcodes

DeliveryDateTime

RecipientDateTime

CreateTime

SenderRef

RecipientRef

WeightFrom

WeightTo

CostFrom

CostTo

SeatsAmountFrom

SeatsAmountTo

CostOnSiteFrom

CostOnSiteTo

StateIds

ScanSheetRef

DateTime

DateTimeFrom

RecipientDateTime

isAfterpayment

Page

OrderField Принимает один из параметров:[IntDocNumber, DateTime, Weight, Cost, SeatsAmount, CostOnSite, CreateTime, EstimatedDeliveryDate, StateId, InfoRegClientBarcodes, RecipientDateTime]

OrderDirection Принимает один из параметров: [DESC, ASC]

ScanSheetRef Идентификатор реестра

Ошибки:

Код Значение

IntDocNumber is undefined

DateTime filtering is invalid format

RecipientDateTime filtering is invalid format

CreateTime filtering is invalid format

DeliveryDateTime filtering is invalid format

OrderField is invalid

OrderDirection is invalid

Page is not specified

InfoRegClientBarcodes

printDocument() - печать ЭН

Метод позволяет получить печатные формы Экспресс Накладных в выбранном формате.


* DocumentRefs массив документов для печати Список Ref-оф документов. Можнополучить через getDocumentList()

Type тип возвращаемого результата Pdf (по умолчанию), Html

Copies к-во копий ЕН double значит две копии (по умолчанию),значение значит четыре копииfourfold

* обязательные поля

Ошибки:

Type is should be html or pdf - неверный тип результирующего документа

Refs is undefined - не указан массив ЭН

Document not found - документ не найден

Пример запроса

{ "apiKey": "Ваш Api ключ", "modelName": "InternetDocument", "calledMethod": "printDocument", "methodProperties": { "DocumentRefs": [ "b85a3c71-47af-11e4-acce-0050568002cf" ], "Type": "Pdf", "Copies": "double", }}

Примеры GET запросов для печати ЭН

Печать по Ref[ВАШ АПИ КЛЮЧ]https://my.novaposhta.ua/orders/printDocument/orders[]/ab91865b-2937-11e4-ab6d-005056801329/type/html/apiKey/

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

https://my.novaposhta.ua/orders/printDocument/orders/ab91865b-2937-11e4-ab6d-005056801329,ab91865b-2937-11e4-ab6d-005056801329/type/html/apiKey/[ВАШ АПИ КЛЮЧ]Вместо Ref можно передавать номер ЭН

https://my.novaposhta.ua/orders/printDocument/orders[]/20600000002260/type/html/apiKey/[ВАШ АПИ КЛЮЧ] Ref и номера можно передавать одновременно. Если передан не в виде массива, то произойдёт его разбиение на массив поordersзапятой.

printMarkings() - печать маркировок


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

Type тип возвращаемого результата Pdf (по умолчанию), Html


Ошибки:

Refs is undefined

Document not found


{ "apiKey": "Ваш Api ключ", "modelName": "InternetDocument", "calledMethod": "printMarkings", "methodProperties": { "DocumentRefs": [ "b85a3c71-47af-11e4-acce-0050568002cf" ], "Type": "Pdf" }}

Примеры GET запросов для печати маркировок

Печать по Refhttps://my.novaposhta.ua/orders/printMarkings/orders[]/ab91865b-2937-11e4-ab6d-005056801329/type/html/apiKey/[ВАШ АПИ КЛЮЧ]

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

https://my.novaposhta.ua/orders/printMarkings/orders/ab91865b-2937-11e4-ab6d-005056801329,ab91865b-2937-11e4-ab6d-005056801329/type/html/apiKey/[ВАШ АПИ КЛЮЧ]

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

https://my.novaposhta.ua/orders/printMarkings/orders[]/20600000002260/type/html/apiKey/[ВАШ АПИ КЛЮЧ] Ref и номера можно передавать одновременно. Если orders передан не в виде массива, то произойдёт его разбиение на массив позапятой

Печать на принтере для печати штрих-кодов (Zebra)https://my.novaposhta.ua/orders/printMarkings/orders/ab91865b-2937-11e4-ab6d-005056801329,ab91865b-2937-11e4-ab6d-005056801329/type/html/apiKey/[ВАШ АПИ КЛЮЧ]/zebra/zebra

Печать несколько маркировок в одном запросеhttps://my.novaposhta.ua/orders/printMarkings/orders/20600000002310,20600000002309/type/html/apiKey/[ВАШ АПИ КЛЮЧ]

[ВАШ АПИ КЛЮЧ]

documentsTracking() - трекинг документов

Принимает массив номеров документов, отдает результат трекинга вместе со связанными документами.

Свойства ответа:

Имя свойства Описание

Barcode Номер документа

StateId Идентификатор статуса

StateName Полное описание статуса

DocumentCost Стоимость доставки

RecipientFullName ФИО получателя

ReceiptDateTime Дата, когда груз забрал получатель

ReasonDescription Причина отказа

Sum Стоимость доставки

DocumentWeight Вес груза

isEWPaid Оплачена ли ЕН

isEWPaidCashLess Оплачена ли ЕН безналом

ewPaidSumm Фактическая сумма оплаты

CheckWeight Вес груза после перевзвеса

SumBeforeCheckWeight Сумма доставки до перевзвеса

ChildDocuments Документы, созданные на основании первичной

Запрос:

{ "modelName": "InternetDocument", "calledMethod": "documentsTracking", "methodProperties": { "Documents": [ "20600000002354", "20600000002354" ] }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

Ответ:

{ "success": true, "data": [ { "Barcode": "20600000002354", "StateId": "4", "StateName": "Готується до відправлення", "DocumentCost": "18", "CheckWeight": "0.00", "RecipientFullName": "", "ReceiptDateTime": "", "ReasonDescription": "", "Sum": 0, "DocumentWeight": 0, "SumBeforeCheckWeight": "", "isEWPaid": false, "isEWPaidCashLess": false, "ewPaidSumm": 0, "ChildDocuments": [] } ], "errors": [], "warnings": [], "info": []}

generateReport()

Формирует отчёт по накладным за определённый период

Type [xls, csv]

DocumentRefs

И все остальные параметры из getDocumentList()

Ошибки:

Refs is undefined

Document not found

Common - Модель для работы со справочниками

Пример запроса Пример ответа Пример ошибки

{

"apiKey": "Ключ АРІ",

"modelName": "Common",

"calledMethod":"getBackwardDeliveryCargoTypes",

"modelProperties": {

"CounterpartyRef":"ffc0e81c-9eba-11e3-9d3b-0025909b4e33"

}

}

{

"success": true,

"data": [

{

"Description": "Документи",

"Ref": "Documents"

},

{

"Description": "Цінні папери",

"Ref": "Money"

},

{

"Description": "Піддони (тара)",

"Ref": "Trays"

},

{

"Description": "Інше",

"Ref": "Other"

}

],

"errors": [],

"warnings": [],

"info": []

}

{

" ": false,success

" ": [ ],data

" ": {errors

" ":BackwardDeliveryData"BackwardDelivery CargoType, PayerTypeand RedeliveryString must be filled"

},

" ": [ ],warnings

" ": [ ]info

}

getBackwardDeliveryCargoTypes() - получить список видов обратной доставки груза

Метод: — получение списка видов обратной доставки груза (по услуге "Обратная доставка"):getBackwardDeliveryCargoTypes()

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


{"modelName": "Common","calledMethod": "getBackwardDeliveryCargoTypes","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ru"}

Language может быть ru, ua, en


{ "success": true, "data": [ { "Description": "Документы", "Ref": "Documents" }, { "Description": "Ценные бумаги", "Ref": "Money" }, { "Description": "Поддоны", "Ref": "Trays" }, { "Description": "Другое", "Ref": "Other" } ], "errors": [], "warnings": [], "info": []}

getCargoDescriptionList() - загрузить справочник описания груза

Метод: — загрузить справочник описания груза.getCargoDescriptionList()



FindByString Поиск по строкам

Page Страница до 500 записей на странице

Пример запроса:

{"modelName": "Common","calledMethod": "getCargoDescriptionList","methodProperties": {},"apiKey": "Ваш ключ Api"}


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

{ "success": true, "data": [ { "Ref": "8f46973e-33e4-11e3-b441-0050568002cf", "Description": "DVD/HD- медіаплеєр", "DescriptionRu": "DVD/HD- медиаплеер" }, { "Ref": "f297a497-3cb8-11dd-84e9-001a92567626", "Description": "абажур", "DescriptionRu": "абажур" }, .... ], "errors": [], "warnings": [], "info": []}

getCargoTypes() - загрузить список видов груза

Метод: — позволяет получить список типов груза:getCargoTypes()

«груз»«документы»«шины-диски»«паллеты»



{"modelName": "Common","calledMethod": "getCargoTypes","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{ "success": true, "data": [ { "Description": "Груз", "Ref": "Cargo" }, { "Description": "Документы", "Ref": "Documents" }, { "Description": "Шины-диски", "Ref": "TiresWheels" }, { "Description": "Паллеты", "Ref": "Pallet" } ], "errors": [], "warnings": [], "info": []}

getDocumentStatuses() - загрузить список статусов документов

Общий запрос:

{ "modelName": "Common", "calledMethod": "getDocumentStatuses", "apiKey": "[ВАШ АПИ КЛЮЧ]"}

Ответ:

{ "success": true, "data": [ { "StateId": "1", "StateName": "Замовлення в обробці",

"GroupId": "11"

"GroupId": "11" }, { "StateId": "2", "StateName": "Видалено", "GroupId": "3" }, { "StateId": "3", "StateName": "Номер не знайдено", "GroupId": "0" }, { "StateId": "4", "StateName": "Готується до відправлення", "GroupId": "10" }, { "StateId": "5", "StateName": "Відправлено", "GroupId": "6" }, { "StateId": "6", "StateName": "Готується до видачі", "GroupId": "8" }, { "StateId": "7", "StateName": "Прибув у відділення", "GroupId": "25" }, { "StateId": "8", "StateName": "Невизначено", "GroupId": "18" }, { "StateId": "9", "StateName": "На шляху до Одержувача", "GroupId": "15" }, { "StateId": "10", "StateName": "Одержаний", "GroupId": "19" }, { "StateId": "11", "StateName": "Відмова", "GroupId": "5" }, { "StateId": "12", "StateName": "Відміняється", "GroupId": "4" }, { "StateId": "13", "StateName": "Припинено зберігання", "GroupId": "28" }, {

"StateId": "14",

"StateId": "14", "StateName": "Змінено адресу", "GroupId": "14" }, { "StateId": "15", "StateName": "Зворотна доставка", "GroupId": "12" }, { "StateId": "16", "StateName": "Зворотна доставка грошовий переказ Global Money", "GroupId": "13" }, { "StateId": "17", "StateName": "Переадресування", "GroupId": "22" }, { "StateId": "18", "StateName": "Повернення", "GroupId": "23" }, { "StateId": "19", "StateName": "Нараховується плата за зберігання", "GroupId": "17" } ], "errors": [],

"warnings": [],

"warnings": [], "info": []}

Запрос на забор одного статуса (в свойствах метода можно передавать фильтр по GroupId, StateId, StateName)

{ "modelName": "Common", "calledMethod": "getDocumentStatuses", "methodProperties": { "StateId": "1" }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

Ответ

{ "success": true, "data": [ { "StateId": "1", "StateName": "Замовлення в обробці", "GroupId": "11" } ], "errors": [], "warnings": [], "info": []}

getOwnershipFormsList() - загрузить список форм собственности

Метод: — получение списка форм собственностиgetOwnershipFormsList()



{"modelName": "Common","calledMethod": "getOwnershipFormsList","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{

{ "success": true, "data": [ { "Ref": "7f0f3516-2519-11df-be9a-000c291af1b3", "Description": "ПК", "FullName": "Производственный кооператив" }, { "Ref": "7f0f3515-2519-11df-be9a-000c291af1b3", "Description": "ГП", "FullName": "Государственное предприятие" }, { "Ref": "7f0f3518-2519-11df-be9a-000c291af1b3", "Description": "КП", "FullName": "Коммунальное предприятие" }, { "Ref": "10d78dad-2352-11e2-83ab-d4ae52ab9fab", "Description": "КО", "FullName": "Коммандитное общество" }, { "Ref": "361b83db-886e-11e1-a146-0026b97ed48a", "Description": "ПАО", "FullName": "Публичное акционерное общество" }, { "Ref": "9252696e-2202-11e4-acce-0050568002cf", "Description": "ПИИ", "FullName": "Предприятие с иностранными инвестициями" }, { "Ref": "7f0f3519-2519-11df-be9a-000c291af1b3", "Description": "ЧП", "FullName": "Частное предприятие (не частный предприниматель)" }, { "Ref": "b0b2c790-8920-11e1-8429-0026b97ed48a", "Description": "ЧАО", "FullName": "Акционерное общество (ПАО, ЧАО, ОАО, ЗАО)" }, { "Ref": "7f0f3514-2519-11df-be9a-000c291af1b3", "Description": "ПО", "FullName": "Полное общество" }, { "Ref": "7f0f351a-2519-11df-be9a-000c291af1b3", "Description": "СП", "FullName": "Совместное предприятие" }, { "Ref": "7f0f351c-2519-11df-be9a-000c291af1b3", "Description": "ОДО", "FullName": ", Общество с дополнительной ответственностью" }, { "Ref": "7f0f351d-2519-11df-be9a-000c291af1b3", "Description": "ООО", "FullName": ", Общество с ограниченной ответственностью" },

{

{ "Ref": "7f0f3517-2519-11df-be9a-000c291af1b3", "Description": "ФХ", "FullName": "Фермерское хозяйство" }, { "Ref": "7f0f351e-2519-11df-be9a-000c291af1b3", "Description": "ФЛП (СПД)", "FullName": "Физ. Лицо-предприниматель (только частный предприниматель)" } ], "errors": [],

"warnings": [],


getPalletsList() - загрузить список поддонов (при заказе услуги обратная доставкаподдонов)

Метод: — загрузить список поддонов (используется, если заказана услуга )getPalletsList() обратной доставки поддонов


{ "modelName": "Common", "calledMethod": "getPalletsList", "methodProperties": {}, "apiKey": "Ваш ключ Api"}



{ "success": true, "data": [ { "Ref": "627b0c23-d110-11dd-8c0d-001d92f78697", "Description": "Палета від 1,5 м2 до 2 м2", "DescriptionRu": "Паллета свыше 1,5 м2", "Weight": "816.00" }, { "Ref": "627b0c24-d110-11dd-8c0d-001d92f78697", "Description": "Палета від 1 м2 до 1,49 м2", "DescriptionRu": "Паллета от 1 м2 до 1,5 м2", "Weight": "612.00" }, { "Ref": "627b0c25-d110-11dd-8c0d-001d92f78697", "Description": "Палета від 0,5 м2 до 0,99 м2", "DescriptionRu": "Паллета от 0,5 м2 до 1м2", "Weight": "408.00" }, { "Ref": "627b0c26-d110-11dd-8c0d-001d92f78697", "Description": "Палета до 0,49 м2", "DescriptionRu": "Паллета до 0,49 м2", "Weight": "204.00" } ], "errors": [], "warnings": [], "info": []}

getPaymentForms() - загрузить список форм оплаты

Метод: — получение списка форм оплаты: наличный расчет, безналичный расчет.getPaymentForms()

Оплачивать услуги доставки с помощью безналичного расчета могут Клиенты, которые заключили договор с компанией "НоваяПочта"



{"modelName": "Common","calledMethod": "getPaymentForms","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{ "success": true, "data": [ { "Description": "Безготівковий", "Ref": "NonCash" }, { "Description": "Готівка", "Ref": "Cash" } ], "errors": [], "warnings": [], "info": []}

getServiceTypes() - загрузить справочник технологий доставки

Метод: — получение списка возможных типов технологий доставки: «склад-склад», «двери-двери»,getServiceTypes()«склад-двери», «двери-склад»



{"modelName": "Common","calledMethod": "getServiceTypes","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{ "success": true, "data": [ { "Description": "Двері-Двері", "Ref": "DoorsDoors" }, { "Description": "Двері-Склад", "Ref": "DoorsWarehouse" }, { "Description": "Склад-Склад", "Ref": "WarehouseWarehouse" }, { "Description": "Склад-Двері", "Ref": "WarehouseDoors" } ], "errors": [], "warnings": [], "info": []}

getTimeIntervals() - загрузить список временных интервалов (для заказа услуги"Временные интервалы")

Метод getTimeIntervals() - получения списка временных интервалов для указанного города



RecipientCityRef Город для которого будут полученычасовые интервалы

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

DateTime Дата на которую будут полученычасовые интервалы

необязательный параметрпо умолчанию равен текущей датеформат dd.mm.YYYY


{ "modelName": "Common", "calledMethod": "getTimeIntervals", "methodProperties": { "RecipientCityRef": "8d5a980d-391c-11dd-90d9-001a92567626", "DateTime": "18.09.2015" }, "apiKey": "Ваш ключ Api"}


{ "success": true, "data": [ { "Number": "CityDeliveryTimeInterval2", "Start": "12:01", "End": "15:00" }, { "Number": "CityDeliveryTimeInterval3", "Start": "15:01", "End": "18:00" }, { "Number": "CityDeliveryTimeInterval4", "Start": "18:01", "End": "21:00" } ], "errors": [], "warnings": [], "info": []}

getTiresWheelsList() - загрузить список шин и дисков (если вид груза "шины-диски")

Метод: — получение списка шин и дисков (используется, если )getTiresWheelsList() вид груза «шины-диски»


{"modelName": "Common","calledMethod": "getTiresWheelsList","methodProperties": {},"apiKey": "Ваш ключ Api"}


{ "success": true, "data": [ {

{ "Ref": "20f7b625-9add-11e3-b441-0050568002cf", "Description": "Шина вантажна R 22,5", "DescriptionRu": "Шина грузовая R 22,5", "Weight": "94.00", "DescriptionType": "Tires" }, { "Ref": "20f7b626-9add-11e3-b441-0050568002cf", "Description": "Шина вантажна R 17,5 ", "DescriptionRu": "Шина грузовая R 17,5", "Weight": "35.00", "DescriptionType": "Tires" }, { "Ref": "20f7b627-9add-11e3-b441-0050568002cf", "Description": "Шина вантажна R 19,5", "DescriptionRu": "Шина грузовая R 19,5", "Weight": "61.00", "DescriptionType": "Tires" }, { "Ref": "20f7b628-9add-11e3-b441-0050568002cf", "Description": "Шина вантажна R 20", "DescriptionRu": "Шина грузовая R 20", "Weight": "105.00", "DescriptionType": "Tires" }, { "Ref": "d7c456c5-aa8b-11e3-9fa0-0050568002cf", "Description": "Шина легкова R 13-14", "DescriptionRu": "Шина легковая R 13-14", "Weight": "14.90", "DescriptionType": "Tires" }, { "Ref": "d7c456c6-aa8b-11e3-9fa0-0050568002cf", "Description": "Шина легкова R 15-17", "DescriptionRu": "Шина легковая R 15-17", "Weight": "23.09", "DescriptionType": "Tires" }, { "Ref": "d7c456c7-aa8b-11e3-9fa0-0050568002cf", "Description": "Шина легкова R 18-19", "DescriptionRu": "Шина легковая R 18-19", "Weight": "29.48", "DescriptionType": "Tires" }, { "Ref": "d7c456c8-aa8b-11e3-9fa0-0050568002cf", "Description": "Шина легкова R 20-21", "DescriptionRu": "Шина легковая R 20-21", "Weight": "34.77", "DescriptionType": "Tires" }, { "Ref": "d7c456c9-aa8b-11e3-9fa0-0050568002cf", "Description": "Шина легкова R 23", "DescriptionRu": "Шина легковая R 23", "Weight": "43.32", "DescriptionType": "Tires" },

{

{ "Ref": "d7c456ca-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск вантажний R 17,5 ", "DescriptionRu": "Диск грузовой R 17,5", "Weight": "28.00", "DescriptionType": "Wheels" }, { "Ref": "d7c456cb-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск вантажний R 19,5", "DescriptionRu": "Диск грузовой R 19,5", "Weight": "45.00", "DescriptionType": "Wheels" }, { "Ref": "d7c456cc-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск вантажний R 20", "DescriptionRu": "Диск грузовой R 20", "Weight": "80.00", "DescriptionType": "Wheels" }, { "Ref": "d7c456cd-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск вантажний R 22,5", "DescriptionRu": "Диск грузовой R 22,5", "Weight": "70.00", "DescriptionType": "Wheels" }, { "Ref": "d7c456cf-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск легковий R 13-14", "DescriptionRu": "Диск легковой R 13-14", "Weight": "8.75", "DescriptionType": "Wheels" }, { "Ref": "d7c456d0-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск легковий R 15-17", "DescriptionRu": "Диск легковой R 15-17", "Weight": "15.42", "DescriptionType": "Wheels" }, { "Ref": "d7c456d1-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск легковий R 18-19", "DescriptionRu": "Диск легковой R 18-19", "Weight": "23.75", "DescriptionType": "Wheels" }, { "Ref": "d7c456d2-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск легковий R 20-21", "DescriptionRu": "Диск легковой R 20-21", "Weight": "40.00", "DescriptionType": "Wheels" }, { "Ref": "d7c456d3-aa8b-11e3-9fa0-0050568002cf", "Description": "Диск легковий R 23", "DescriptionRu": "Диск легковой R 23", "Weight": "52.50", "DescriptionType": "Wheels" }

],

], "errors": [],

"warnings": [],


getTraysList() - загрузить список поддонов (если заказана услуга обратной доставкиподдонов)

Метод: getTraysList () — получение списка поддонов (используется, если заказана )услуга обратной доставки поддонов


{"modelName": "Common","calledMethod": "getTraysList","methodProperties": {},"apiKey": "Ваш ключ Api"}


{ "success": true, "data": [ { "Ref": "d5c36c5c-a29d-11de-a2ca-000c294065a1", "Description": "Європейський стандарт Є", "DescriptionRu": "Европейский стандарт Є", "Weight": "0.00" }, { "Ref": "d5c36c5d-a29d-11de-a2ca-000c294065a1", "Description": "Американський стандарт А", "DescriptionRu": "Американский стандарт А", "Weight": "0.00" } ], "errors": [], "warnings": [], "info": []}

getTypesOfCounterparties() - загрузить список типов контрагентов отправителей

Метод: — загрузка списка типов контрагентов getTypesOfCounterparties()



{"modelName": "Common","calledMethod": "getTypesOfCounterparties","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ru"}



{ "success": true, "data": [ { "Description": "Организация", "Ref": "Organization" }, { "Description": "Частное лицо", "Ref": "PrivatePerson" } ], "errors": [], "warnings": [], "info": []}

getTypesOfPayers() - загрузить список видов плательщиков

Метод: — получение списка видов плательщиков услуги доставки: Отправитель, Получатель, Третье лицо.getTypesOfPayers()

Вид плательщика "Третье лицо" возможно заказать только после заключения договора с компанией "Новая Почта"



{"modelName": "Common","calledMethod": "getTypesOfPayers","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{ "success": true, "data": [ { "Description": "Відправник", "Ref": "Sender" }, { "Description": "Отримувач", "Ref": "Recipient" }, { "Description": "Третя особа", "Ref": "ThirdPerson" } ], "errors": [], "warnings": [], "info": []}

getTypesOfPayersForRedelivery() - загрузить список видов плательщиков обратнойдоставки

Метод: — получение списка видов плательщиков услуги обратной доставки: Отправитель,getTypesOfPayersForRedelivery()Получатель.



{"modelName": "Common","calledMethod": "getTypesOfPayersForRedelivery","methodProperties": {},"apiKey": "Ваш ключ Api","language": "ua"}



{ "success": true, "data": [ { "Description": "Отправитель", "Ref": "Sender" }, { "Description": "Получатель", "Ref": "Recipient" } ], "errors": [], "warnings": [], "info": []}

Counterparty - Модель для работы с данными контрагента

Модель для работы с данными контрагента отправителя/получателя: Counterparty


{

"apiKey": "[ВАШ АПИ КЛЮЧ]",

"modelName": "Counterparty",

"calledMethod": "save",


"CityRef":"db5c88de-391c-11dd-90d9-001a92567626",

"FirstName": "Микола3",

"MiddleName": "Іванович",

"LastName": "Микитенко",

"Phone": "0997979789",

"Email": "",

"CounterpartyType": "PrivatePerson",

"CounterpartyProperty": "Recipient"

}

}

{

"success": true,

"data": [

{

"Ref":"0aca598d-d6ac-11e3-95eb-0050568046cd",

"Description": "Микитенко Микола3Іванович",




"Counterparty": "",

"OwnershipForm": null,

"OwnershipFormDescription": "",

"EDRPOU": "",

"CounterpartyType":"PrivatePerson",

"ContactPerson": {

"success": true,

"data": [

{

"Ref":"c3a3bc31-d6a7-11e3-95eb-0050568046cd",

"Description": "МикитенкоМикола3 Іванович",




"Phones": "380997979789",

"Email": null,

"Owner":"0aca598d-d6ac-11e3-95eb-0050568046cd"

}

],

"errors": [],

"warnings": [],

"info": []

}

}

],

"errors": [],

"warnings": [],

"info": []

}

{

" ": false,success

" ": [ ],data

" ": {errors

" ": "Phone is not specified",Phone

" ": "Email invalid format"Email

},

" ": [ ],warnings

" ": [ ]info

}

save() - сохранить контрагента

Метод: — сохранение контрагента отправителя/получателяsave()


* CounterpartyProperty свойство контрагента,[Отправитель/Получатель]

Sender, Recipient

* CityRef Идентификатор города

* CounterpartyType Тип контрагента Organization - используется, еслиОтправитель (Получатель) отправленияюридическое лицо

PrivatePerson - используется, еслиОтправитель (Получатель) отправленияфизическое лицо

* FirstName Имя - Если тип контрагента юридическоелицо – указывается названиеПредприятия (Организации). Запрещено указывать наименованиеорганизации - «частное лицо»,«приватна особа» и т.д.

- Если тип контрагента физическое лицо– указывается имяОтправителя/Получателя

* MiddleName Отчество Параметр используется если типконтрагента физическое лицо

* LastName Фамилия Параметр используется если типконтрагента физическое лицо

*Phone телефон Формат 0XXXXXXXXX

Email email

EDRPOU Код ОКПО Параметр используется если типконтрагента юридическое лицо

** OwnershipForm

(обязательное только когдаОрганизация)

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

saveThirdPerson() - сохранить контрагента с типом "третье лицо"

Функция доступна для клиентов, заключивших договор с компанией "Новая Почта"

update() - обновить данные контрагента

Метод: update() — обновление контрагента


* Ref идентификатор контрагента

* CounterpartyProperty свойство контрагента,[Отправитель/Получатель]

Sender, Recipient, ThirdPerson


* CounterpartyType Тип контрагента Organization - используется, еслиОтправитель (Получатель) отправленияюридическое лицо

PrivatePerson - используется, еслиОтправитель (Получатель) отправленияфизическое лицо

* FirstName Имя Параметр используется если типконтрагента физическое лицо

* MiddleName Отчество Параметр используется если типконтрагента физическое лицо

* LastName Фамилия Формат 0XXXXXXXXX

** Phone телефон

Email email Параметр используется если типконтрагента юридическое лицо

EDRPOU Код ОКПО Параметр используется если типконтрагента юридическое лицо

** OwnershipForm форма собственности

updateThirdPerson() - обновить данные контрагента с типом "третье лицо"

Функция доступна для Клиентов, заключивших договор с компанией "Новая Почта"

delete() - удалить контрагента отправителя/получателя

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

Метод: cloneLoyaltyCounterpartySender — создает контрагента-отправителя, если выбранный город-отправитель отличается отгорода в котором зарегистрирован пользователь


* CityRef Идентификатор города Пункт 1.4

getCounterparties() - загрузить список контрагентов отправителей/получателей

Метод: getCounterparties — получение списка контрагентов отправителей/получателей


CounterpartyProperty Вид контрагента: Отправитель,Получатель

Свойства с пункта

Sender, Recipient

Page Страницы до 2000 тыс. записей на странице

FindByString Поиск по строкам

CityRef Идентификатор города контрагента

getCounterpartyAddresses() - загрузить список адресов контрагентов

Метод: getCounterpartyAddresses — получение списка адресов контрагентов отправителей/получателей



Page Страница до 250 тыс. записей на странице

getCounterpartyContactPersons() - загрузить список контактных лиц контрагента

Метод: getCounterpartyContactPersons — получение списка контактных лиц контрагента отправителя/получателя



Page Страница До 250 тыс. записей на странице

getCounterpartyByEDRPOU() - найти контрагента по коду ОКПО

Метод: getCounterpartyByEDRPOU — получение контрагента по коду ОКПО.


* EDRPOU Код ОКПО


getCounterpartyOptions() - загрузить параметры контрагента

Метод: getCounterpartyOptions — получить параметры контрагента отправителя/получателя


* Ref Идентификатор контрагента

ContactPerson - Модель для создания контактного лица

Модель для изменения контактного лица для отправителя/получателя-юридического лица:

Параметр Описание Значение

* Ref Идентификатор контактного лица,которое требуется изменить

ref

* CounterpartyRef Идентификатор контрагента, к которомупривязать контактное лицо

ref

* FirstName Имя

MiddleName Отчество

* LastName Фамилия

* Phone Номер телефона +380ххххххххх

Email Email



{

" ": "[ВАШ АПИ КЛЮЧ]",apiKey

" ": "ContactPerson",modelName

" ": "save",calledMethod


" ":Ref"0f6d3e28-7bb0-11e4-acce-0050568002cf",

" ":CounterpartyRef"cff51743-00aa-11e4-acce-0050568002cf",

" ": "Микола",FirstName

" ": "Іванович",MiddleName

" ": "Микитенко",LastName

" ": "+380997979789",Phone

" ": ""Email

}

}

{

" ": true,success

" ": [data

{

" ":Ref"afe10488-b428-11e3-988c-005056801329",

" ": "Микитенко МиколаDescriptionІванович",

" ": "Микитенко",LastName

" ": "Микола",FirstName

" ": "Іванович",MiddleName

" ": "380997979789",Phones

" ": null,Email

" ":Owner"ffc0e81c-9eba-11e3-9d3b-0025909b4e33"

}

],

" ": [ ],errors

" ": [ ],warnings

" ": [ ]info

}

{

" ": false,success

" ": [ ],data

" ": {errors

" ": "Phone is not specified",Phone

" ": "Email invalid format"Email

},

" ": [ ],warnings

" ": [ ]info

}

save() - сохранить данные контактного лица отправителя/получателя

Метод: — сохранение данных контактного лицаsave()


* CounterpartyRef Идентификатор контрагента

* FirstName Имя Необходимо указывать на украинскомязыке без использования символов «! ”№ ; % : ? *»* MiddleName Отчество


* Phone Номер телефона Формат 0XXXXXXXXX

Email Электронная почта

update() - обновить данные контактного лица

Метод: — обновление данных контактного лицаupdate()


* CounterpartyRef Идентификатор контрагента

* FirstName Имя Необходимо указывать на украинскомязыке без использования символов «! ”№ ; % : ? *»* MiddleName Отчество


* Phone Номер телефона Формат 0XXXXXXXXX

Email Электронная почта

delete() - удалить контактное лицо отправителя/получателя

Метод: — метод удаляет контактное лицо отправителя/получателя (только для владельцев контрагентов-юридических лиц)delete()

Параметр Описание Значение

* Ref Идентификатор контактного лица ref


Address - Модель для работы с адресами

save() - создать адрес отправителя/получателя

Метод: - сохранение адреса отправителя/получателяsave()


* CounterpartyRef идентификатор контрагента

* StreetRef идентификатор улицы

* BuildingNumber номер дома

Flat квартира

Note комментарий

Пример запроса JSON Пример ответа Пример ошибки

{

" ": "ключ API Клиента",apiKey

" ": "Address",modelName

" ": "save",calledMethod

" ": {modelProperties

" ":CounterpartyRef"ffc0e81c-9eba-11e3-9d3b-0025909b4e33",

" ":StreetRef"d4450bdb-0a58-11de-b6f5-001d92f78697",

"BuildingNumber": "7",

" ": "2",Flat

" ": "Комментарий"Note

}

}

{

" ": true,success

" ": [data

{

" ":Ref"60b54081-b41f-11e3-988c-005056801329",

" ": "ЖовтневаDescription(Вишневе) вул. 16 кв. 1 Коментар"

}

],

" ": [ ],errors

" ": [ ],warnings

" ": [ ]info

}

{

" ": false,success

" ": [ ],data

" ": {errors

"BuildingNumber": "BuildingNumber isnot specified"

},

" ": [ ],warnings

" ": [ ]info

}

BuildingNumber

update() - редактировать адрес отправителя/получателя

Метод: - обновление адреса отправителя/получателяupdate()

Метод: - обновление адреса отправителя/получателяupdate()


* CounterpartyRef идентификатор контрагента

* StreetRef идентификатор улицы

* BuildingRef номер дома

Flat квартира

Note комментарий

delete() - удалить ранее созданный адрес

Метод: - удаление адреса отправителя/получателяdelete()


* Ref Идентификатор удаляемого адреса

getCities() - загрузить справочник городов компании «Новая Почта»

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

Метод: — получение справочника городов компании «Новая Почта»getCities

Входные переменные


Page Страница до 1500 тыс. записей на странице

FindByString Поиск по строкам русский либо украинский язык

Ref Идентификатор города

Поля ответа

Параметр Описание Примечание

Description Название Украинский язык

DescriptionRu Название Русский язык

Ref Идентификатор

Delivery1 Доставка в понедельник 1 – доставка осуществляется вобозначенный день недели,

0 – доставка не осуществляется вобозначенный день недели

Delivery2 Доставка во вторник

Delivery3 Доставка в среду

Delivery4 Доставка в четверг

Delivery5 Доставка в пятницу

Delivery6 Доставка в субботу

Delivery7 Доставка в воскресенье

Area Регион

Conglomerates Конгломерат

Пример запроса для загрузки

справочника городов


{

"apiKey": "ключ API Клиента",

"modelName": "Address",

"calledMethod": "getCities",


"Page": "1"

}

}

{ "success": true, "data": [

{ "Description": "Агрономічне", "DescriptionRu": "Агрономичное", "Ref": "ebc0eda9-93ec-11e3-b441-0050568002cf", "Delivery1": "1", "Delivery2": "0", "Delivery3": "1", "Delivery4": "0", "Delivery5": "1", "Delivery6": "0", "Delivery7": "0", "Area": "71508129-9b87-11de-822f-000c2965ae0e", "Conglomerates": "" }, { "Description": "Ананьїв", "DescriptionRu": "Ананьев", "Ref": "06f8796e-4079-11de-b509-001d92f78698", "Delivery1": "1", "Delivery2": "1", "Delivery3": "1", "Delivery4": "1", "Delivery5": "1", "Delivery6": "0", "Delivery7": "0", "Area": "71508136-9b87-11de-822f-000c2965ae0e", "Conglomerates": "" }, { "Description": "Андріївка (Бердянськ)", "DescriptionRu": "Андреевка (Бердянск)", "Ref": "f4890a83-8344-11df-884b-000c290fbeaa", "Delivery1": "0", "Delivery2": "1", "Delivery3": "0", "Delivery4": "0", "Delivery5": "0", "Delivery6": "0", "Delivery7": "0", "Area": "7150812f-9b87-11de-822f-000c2965ae0e", "Conglomerates": "" },

…

],

"errors": [],

"warnings": [],

"info": []

}

getStreet() - загрузить справочник улиц компании «Новая Почта»


* FindByString Поиск по строкам

Page Страница


getWarehouses() - загрузить справочник отделений компании «Новая Почта»

Метод: — получение справочника отделений компании «Новая Почта»getWarehouses



Page Страница до 500 записей на странице


{ "modelName": "Address", "calledMethod": "getWarehouses", "methodProperties": { "CityRef": "ebc0eda9-93ec-11e3-b441-0050568002cf" }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}


{ "success": true, "data": [ { "Description": "Відділення №1: вул. Мічуріна, 28", "DescriptionRu": "Отделение №1: ул. Мичурина, 28", "Ref": "2bb8cecb-e1c2-11e3-8c4a-0050568002cf", "Number": "1", "Longitude": "28.373648000000000", "Latitude": "49.191362000000000" } ], "errors": [], "warnings": [], "info": []}

getAreas() - загрузить справочник географических областей Украины


Page Страница

Ref Идентификатор области

Выходящие параметры:


Description Название

Ref Идентификатор области

AreasCenter Идентификатор города, которыйявляется областным центром

Description

findNearestWarehouse - поиск ближайшего склада по текстовому представлению адреса

Метод: - поиск ближайшего склада по текстовому представлению адреса (Полтавська обл, Полтавский р-н,findNearestWarehouse()Полтава, ул Октябрьская 19). Принимает массив значений, возвращает массив из 5 ближайших объектов или строку "Not found"если текст распознать не удалось.


* SearchStringArray массив строк с полным текстовым представлением адреса

Пример запроса JSON Пример ответа Пример ошибки

{

" ": "ключ API Клиента",apiKey

" ": "Address",modelName

" ":calledMethod"findNearestWarehouse",

" ": {modelProperties

" :[SearchStringArray

"Тестовый текстовый город,Вероятная улица, 666",

"Полтавська обл, Полтавскийр-н, Полтава, ул Октябрьская 19"

]

}

}

{

" ": true,success

" ": [data

{

"0": "Not found", "1": [ { "CityRef":"db5c8892-391c-11dd-90d9-001a92567626", "WarehouseRef":"48ae7f49-7d6b-11e1-beca-0026b97ed48a", "Distance":0.040261977365931 }, { "CityRef":"db5c8892-391c-11dd-90d9-001a92567626", "WarehouseRef":"6ba36ee4-a051-11e2-a57a-d4ae527baec3", "Distance": 0.51879342431639 }, { "CityRef":"db5c8892-391c-11dd-90d9-001a92567626", "WarehouseRef":"f28b56be-37e2-11df-9b28-000c296d6de9", "Distance": 0.99077647783381 }, { "CityRef":"db5c8892-391c-11dd-90d9-001a92567626", "WarehouseRef":"d5150017-7ff8-11e1-beca-0026b97ed48a", "Distance": 1.1590140945037 }, { "CityRef":"db5c8892-391c-11dd-90d9-001a92567626", "WarehouseRef":"9e43ad1b-63ae-11e1-ae72-0026b97ed48a", "Distance": 1.5023506331291 } ]

}

],

" ": [ ],errors

" ": [ ],warnings

" ": [ ]info

}

{

" ": false,success

" ": [ ],data

" ": {errors

"SearchStringArray should be array"

},

" ": [ ],warnings

" ": [ ]info

}

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

При передаче отправлений по Реестру необходимо на каждом отправлении размещать маркировку и распечатать два экземпляраРеестра.

Перечень функций:

insertDocuments() - добавить экспресс-накладные в реестр

Для передачи оформленных отправлений по реестру необходимо сформировать соответствующий запрос.

В реестр не добавляются экспресс-накладные которые удалены/отменены, в которых отличаются данные Отправителя.

В ответ на запрос формирования реестра возвращается номер реестра и номера отправлений со статусом "добавлена" или "недобавлено" в реестр

Входные параметры:

Свойство Тип данных Значение

* DocumentRefs массив Массив документов

Ref идентификатор Идентификатор реестра, если требуетсядобавить документы в существующийреестр

Date дата Дата, если требуется создать реестр наопределенную дату


{ "modelName": "ScanSheet", "calledMethod": "insertDocuments", "methodProperties": { "DocumentRefs": [ "832029fe-718c-11e4-ab6d-005056801329", "832029fe-718c-11e4-ab6d-005056801329" ] }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

removeDocuments() - удалить экспресс-накладные из реестра

После удаления реестра, в информационной системе удаляется номер реестра, но экспресс-накладные, которые содержал реестрне удаляются (происходит расформирование реестра)

Для передачи оформленных отправлений по реестру необходимо сформировать соответствующий запрос.

В реестр не добавляются экспресс-накладные которые удалены/отменены, в которых отличаются данные Отправителя.

В ответ на запрос формирования реестра возвращается номер реестра и номера отправлений со статусом



*DocumentRefs массив Массив ссылок на документысодержащиеся в реестре. Эти документыбудут удалены

Ref идентификатор Идентификатор реестра

Пример запроса JSON

{ "modelName": "ScanSheet", "calledMethod": "removeDocuments", "methodProperties": { "DocumentRefs": [ "832029fe-718c-11e4-ab6d-005056801329", "832029fe-718c-11e4-ab6d-005056801329" ] }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

Пример запроса XML

<?xml version="1.0" encoding="utf-8"?><file> <apiKey>ваш API-ключ </apiKey> <modelName>ScanSheet</modelName> <calledMethod>removeDocuments</calledMethod> <methodProperties> <DocumentRefs> <item>ffb95548-b071-11e4-ac12-005056801333</item> <item>ffb95548-b071-11e4-ac12-005056801334</item> <item>ffb95548-b071-11e4-ac12-005056801335</item> </DocumentRefs> </methodProperties></file>

deleteScanSheet() - удалить (расформировать) реестр отправлений

После удаления реестра, из информационной системы "Новая Почта" удаляется номер реестра,

а экспресс-накладные, которые были включены в него освобождаются, но не удаляются (происходит расформирование реестра)

Для удаления реестра необходимо сформировать соответствующий запрос.



* ScanSheetRefs массив Массив идентификаторов документов

Пример запроса JSON

{ "modelName": "ScanSheet", "calledMethod": "deleteScanSheet", "methodProperties": { "ScanSheetRefs": [ "832029fe-718c-11e4-ab6d-005056801329", "832029fe-718c-11e4-ab6d-005056801329" ] }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

Пример запроса XML

<?xml version="1.0" encoding="utf-8"?><file> <apiKey>ваш API-ключ </apiKey> <modelName>ScanSheet</modelName> <calledMethod>deleteScanSheet</calledMethod> <methodProperties> <ScanSheetRefs> <item>ffb95548-b071-11e4-ac12-005056801333</item> <item>ffb95548-b071-11e4-ac12-005056801334</item> <item>ffb95548-b071-11e4-ac12-005056801335</item> </ScanSheetRefs> </methodProperties></file>

printScanSheet() - загрузка печатной формы реестра

Примеры GET запросов для печати реестров

Печать по ref

https://my.novaposhta.ua/scanSheet/printScanSheet/refs[]/7b044ae7-1ec5-11e4-a699-005056801329/type/pdf/apiKey/[ВАШ АПИ КЛЮЧ]

Печать по номеру реестра

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

переметер должен всегда быть массивом. В одном запросе может быть передан только один номер/ref реестраrefs

getScanSheet() - загрузить информацию по одному реестру


Свойство Тип

Ref Идентификатор реестра

В ответ получите поля:

Свойство Значение


Number Номер реестра

DateTime Дата создания

Count Количество документов в реестре

CitySenderRef Идентификатор города отправителя

CitySender Текстовое представление города отправителя

SenderAddressRef Идентификатор адреса отправителя

SenderAddress Текстовое представление адреса отправителя

SenderRef Идентификатор контрагента отправителя

Sender Текстовое представление контрагента отправителя


{ "modelName": "ScanSheet", "calledMethod": "getScanSheet", "methodProperties": { "Ref": "acf7a47c-73b6-11e4-ab6d-005056801329" }, "apiKey": "[ВАШ АПИ КЛЮЧ]"}

getScanSheetList() - загрузить список реестров

В ответ получите поля:

Свойство Значение


Number Номер реестра

DateTime Дата создания

Printed Признак, распечатан ли реестр


{ "modelName": "ScanSheet", "calledMethod": "getScanSheetList", "apiKey": "[ВАШ АПИ КЛЮЧ]"}

LoyaltyUser - Модель для работы с данными участника программылояльностиФункция на стадии разработки

generateReport() - загрузить отчет "оборот по карте программы лояльности" в форматеxls или csv

getLoyaltyCardDetails() - загрузить информацию по карте участника программылояльности

getLoyaltyCardTurnover() - загрузить информацию по обороту баллов на картеучастника программы лояльности

ArchiveRequest - Модель для работы с архивами экспресс-накладных

save() - создание заявки

Термины и сокращенияЭН (экспресс-накладная) это первичный документ, предназначенный для учета отправлений при перемещении, а так же – взаиморасчетов за доставку.Контрагент – физическое или юридическое лицо Отправитель (Получатель)Обратная доставка – услуга, которая предусматривает доставку отправления, обозначенного в ЭН в поле «зворотнадоставка», Отправителю от ПолучателяОбъемный вес – учитывается при оформлении объемных и относительно легких отправлений. Определяется путемиспользования формул:

Объемный вес(кг)=Длинна(см)хШирина(см)хВысота(см)/4000 илиОбъемный вес(м )=Объемх2503

Количество мест отправления – количество грузовых мест по одной ЭН.