API Адреса
Работа с адресами
- Онлайн поиск в справочнике населенных пунктов
- Онлайн поиск улиц в справочнике населенных пунктов
- Создать адрес контрагента (отправитель/получатель)
- Редактировать адрес контрагента (отправитель/получатель)
- Удалить адрес контрагента (отправитель/получатель)
- Справочник городов компании
- Справочник населенных пунктов Украины
- Справочник географических областей Украины
- Справочник отделений и типов отделений
- Справочник улиц компании
Справочник отделений и типов отделений
Метод «getWarehouses», работает в модели «Address», этот метод загружает справочник отделений «Новая Почта» в рамках населенных пунктов Украины.
Есть возможность отфильтровать нужные отделения по следующим признакам:
1) TypeOfWarehouseRef
2) PostFinance
3) BicycleParking
4) POSTerminal
5) CityName
6) CityRef
Пример:
"methodProperties": {
"BicycleParking": "1",
"TypeOfWarehouseRef":"9a68df70-0267-42a8-bb5c-37f427e36ee4",
"PostFinance": "1",
"CityName":"Київ"
"CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",
}
Предусмотрена возможность быстрого получения отделений в конкретном городе/нас. пункте или поселке, при помощи метода getSettlements
Пример:
"methodProperties": {
"SettlementRef": "e71629ab-4b33-11e4-ab6d-005056801329" //РЕФ города из справочника населенных пунктов Украины
}
Если заменить «getWarehouses» на «getWarehouseTypes», можно получить справочник типов отделений «Новая Почта». Копию справочника необходимо сохранять и поддерживать в актуальном состоянии путем обновления раз в сутки.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
Форматы JSON, XML
Заголовки запросов
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | Свойства метода | |
CityName | string[36] | Дополнительный фильтр по имени города |
CityRef | string[36] | Дополнительный фильтр по идентификатору города |
Page | int[10] | Страница, максимум 500 записей на странице. Работает в связке с параметром Limit |
Limit | int[10] | Количество записей на странице. Работает в связке с параметром Page |
Language | String[2] | Вывод описания на Украинском или русском языках - ru. По умолчанию всегда выводиться на Украинском языке. |
{
"modelName": "AddressGeneral",
"calledMethod": "getWarehouses",
"methodProperties": {
"Language": "ru"
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="UTF-8" ?>
<root>
<modelName>AddressGeneral</modelName>
<calledMethod>getWarehouses</calledMethod>
<methodProperties>
<Language>ru</Language>
</methodProperties>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
</root>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор адреса |
SiteKey | decimal[9999999999] | Код отделения |
Description | string[99] | Название отделения на Украинском |
DescriptionRu | string[99] | Название отделения на русском |
TypeOfWarehouse | string[36] | Тип отделения |
Ref | string[36] | Идентификатор отделения |
Number | int[99999] | Номер отделения |
CityRef | string[36] | Идентификатор населенного пункта |
CityDescription | string[50] | Название населенного пункта на Украинском |
CityDescriptionRu | string[50] | Название населенного пункта на русском |
Longitude | int[50] | Долгота |
Latitude | int[50] | Широта |
PostFinance | int[1] | (1/0) Наличие кассы Пост-Финанс |
POSTerminal | int[1] | (1/0) Наличие пос-терминала на отделении |
InternationalShipping | int[1] | (1/0) Возможность оформления Международного отправления |
TotalMaxWeightAllowed | int[9999999999] | Максимальный вес отправления |
PlaceMaxWeightAllowed | int[9999999999] | Максимальный вес одного места отправления |
Reception | array[7] | График приема отправлений |
Delivery | array[7] | График отправки день в день |
Schedule | array[7] | График работы |
{
"success": true,
"data": [
{
"SiteKey": "10119",
"Description": "Відділення №1: вул. М. Грушевського, 3",
"DescriptionRu": "Отделение №1: ул. М. Грушевского, 3",
"Phone": "0-800-500-609",
"TypeOfWarehouse": "9a68df70-0267-42a8-bb5c-37f427e36ee4",
"Ref": "39931b80-e1c2-11e3-8c4a-0050568002cf",
"Number": "1",
"CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",
"CityDescription": "Заболотів (Снятинський р-н)",
"CityDescriptionRu": "Заболотов (Снятинский р-н)",
"Longitude": "25.299652300000000",
"Latitude": "48.470805500000000",
"PostFinance": "1",
"BicycleParking": "0",
"POSTerminal": "1",
"InternationalShipping": "0",
"TotalMaxWeightAllowed": 0,
"PlaceMaxWeightAllowed": 0,
"Reception": {
"Monday": "15:30-18:00",
"Tuesday": "15:30-18:00",
"Wednesday": "15:30-18:00",
"Thursday": "15:30-18:00",
"Friday": "15:30-18:00",
"Saturday": "-",
"Sunday": "-"
},
"Delivery": {
"Monday": "09:00-15:00",
"Tuesday": "09:00-15:00",
"Wednesday": "09:00-15:00",
"Thursday": "09:00-15:00",
"Friday": "09:00-15:00",
"Saturday": "-",
"Sunday": "-"
},
"Schedule": {
"Monday": "09:00-18:00",
"Tuesday": "09:00-18:00",
"Wednesday": "09:00-18:00",
"Thursday": "09:00-18:00",
"Friday": "09:00-18:00",
"Saturday": "09:00-15:00",
"Sunday": "-"
}
}
],
"errors": [],
"warnings": [],
"info": {
"totalCount": 1
},
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}
<root>
<success>true</success>
<data>
<item>
<Description>Відділення №1: вул. Мічуріна, 28</Description>
<DescriptionRu>Отделение №1: ул. Мичурина, 28</DescriptionRu>
<Phone>(0432) 50-61-41</Phone>
<TypeOfWarehouse>9a68df70-0267-42a8-bb5c-37f427e36ee4</TypeOfWarehouse>
<Ref>2bb8cecb-e1c2-11e3-8c4a-0050568002cf</Ref>
<Number>1</Number>
<CityRef>ebc0eda9-93ec-11e3-b441-0050568002cf</CityRef>
<MaxWeightAllowed />
<Longitude>28.373648000000000</Longitude>
<Latitude>49.191362000000000</Latitude>
<Reception>
<Monday>14:45-18:00</Monday>
<Tuesday>-</Tuesday>
<Wednesday>14:45-18:00</Wednesday>
<Thursday>-</Thursday>
<Friday>14:45-18:00</Friday>
<Saturday>-</Saturday>
<Sunday />
</Reception>
<Delivery>
<Monday>09:00-12:00</Monday>
<Tuesday>-</Tuesday>
<Wednesday>09:00-12:00</Wednesday>
<Thursday>-</Thursday>
<Friday>09:00-12:00</Friday>
<Saturday>-</Saturday>
<Sunday />
</Delivery>
<Schedule>
<Monday>09:00-18:00</Monday>
<Tuesday>09:00-18:00</Tuesday>
<Wednesday>09:00-18:00</Wednesday>
<Thursday>09:00-18:00</Thursday>
<Friday>09:00-18:00</Friday>
<Saturday>09:00-15:00</Saturday>
<Sunday />
</Schedule>
</item>
</data>
<errors />
<warnings />
<info />
</root>