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",
}

Есть возможность получить нужное отделение используя параметры:
1) CityName 2) FindByString
Пример:
"methodProperties": {
"CityName":"Київ",
"FindByString": "Відділення №8"
}

или используя идентификатор отделения Ref
Пример:
"methodProperties": {
"Ref": "47402ec5-e1c2-11e3-8c4a-0050568002cf" //РЕФ отделения из справочника отделений
}

Предусмотрена возможность быстрого получения отделений в конкретном городе/нас. пункте или поселке, при помощи метода 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-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
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] Тип отделения
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) Возможность оформления Международного отправления
SelfServiceWorkplacesCount int[1] (1/0) Наличие рабочего места самообслуживания
WarehouseForAgent int[1] (1/0) Принадлежность отделения к франчайзинговой сети
MaxDeclaredCost int[9999999999] Максимально допустимая оценочная стоимость посылки
TotalMaxWeightAllowed int[9999999999] Максимальный вес отправления
PlaceMaxWeightAllowed int[9999999999] Максимальный вес одного места отправления
SendingLimitationsOnDimensions array[3] Максимальные габариты отправления для отправки
ReceivingLimitationsOnDimensions array[3] Максимальные габариты отправления для получения
Reception array[7] График приема отправлений
Delivery array[7] График отправки день в день
Schedule array[7] График работы 

{
  "success": true,
  "data": [
    {
      "SiteKey": "10119",
      "Description": "Відділення №1: вул. М. Грушевського, 3",
      "DescriptionRu": "Отделение №1: ул. М. Грушевского, 3",
      "ShortAddress": "Заболотів, М. Грушевського, 3",
      "ShortAddressRu": "Заболотов, Грушевского, 3",
      "Phone": "380800500609",
      "TypeOfWarehouse": "9a68df70-0267-42a8-bb5c-37f427e36ee4",
      "Ref": "39931b80-e1c2-11e3-8c4a-0050568002cf",
      "Number": "1",
      "CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",
      "CityDescription": "Заболотів (Снятинський р-н)",
      "CityDescriptionRu": "Заболотов (Снятинский р-н)",
      "SettlementRef": "e717af16-4b33-11e4-ab6d-005056801329",
      "SettlementDescription": "Заболотів",
      "SettlementAreaDescription": "Івано-Франківська область",
      "SettlementRegionsDescription": "Снятинський р-н",
      "SettlementTypeDescription": "селище міського типу",
      "SettlementTypeDescriptionRu": "поселок городского типа",
      "Longitude": "25.284086000000000",
      "Latitude": "48.467503000000000",
      "PostFinance": "1",
      "BicycleParking": "0",
      "PaymentAccess": "0",
      "POSTerminal": "1",
      "InternationalShipping": "1",
      "SelfServiceWorkplacesCount": "0",
      "TotalMaxWeightAllowed": "0",
      "PlaceMaxWeightAllowed": "1000",
      "SendingLimitationsOnDimensions": {
        "Width": 170,
        "Height": 170,
        "Length": 300
      },
      "ReceivingLimitationsOnDimensions": {
        "Width": 170,
        "Height": 170,
        "Length": 300
      },
      "Reception": {
        "Monday": "16:45-18:00",
        "Tuesday": "16:45-18:00",
        "Wednesday": "16:45-18:00",
        "Thursday": "16:45-18:00",
        "Friday": "16:45-18:00",
        "Saturday": "16:30-17:00",
        "Sunday": "10:00-15:00"
      },
      "Delivery": {
        "Monday": "08:00-12:00",
        "Tuesday": "08:00-12:00",
        "Wednesday": "08:00-12:00",
        "Thursday": "08:00-12:00",
        "Friday": "08:00-12:00",
        "Saturday": "09:00-12:00",
        "Sunday": "09:00-14:30"
      },
      "Schedule": {
        "Monday": "09:00-19:00",
        "Tuesday": "09:00-19:00",
        "Wednesday": "09:00-19:00",
        "Thursday": "09:00-19:00",
        "Friday": "09:00-19:00",
        "Saturday": "09:00-18:00",
        "Sunday": "10:00-18:00"
      },
      "DistrictCode": "Ск За",
      "WarehouseStatus": "Working",
      "WarehouseStatusDate": "2013-04-02 00:00:00",
      "CategoryOfWarehouse": "Branch",
      "Direct": "",
      "RegionCity": "ЧЕРНІВЦІ",
      "WarehouseForAgent": "1",
      "MaxDeclaredCost": "0"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": {
    "totalCount": 1
  },
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<root>
<success>true</success>
<data>
	<SiteKey>10119</SiteKey>
	<Description>Відділення №1: вул. М. Грушевського, 3</Description>
	<DescriptionRu>Отделение №1: ул. М. Грушевского, 3</DescriptionRu>
	<ShortAddress>Заболотів, М. Грушевського, 3</ShortAddress>
	<ShortAddressRu>Заболотов, Грушевского, 3</ShortAddressRu>
	<Phone>380800500609</Phone>
	<TypeOfWarehouse>9a68df70-0267-42a8-bb5c-37f427e36ee4</TypeOfWarehouse>
	<Ref>39931b80-e1c2-11e3-8c4a-0050568002cf</Ref>
	<Number>1</Number>
	<CityRef>20982d74-9b6c-11e2-a57a-d4ae527baec3</CityRef>
	<CityDescription>Заболотів (Снятинський р-н)</CityDescription>
	<CityDescriptionRu>Заболотов (Снятинский р-н)</CityDescriptionRu>
	<SettlementRef>e717af16-4b33-11e4-ab6d-005056801329</SettlementRef>
	<SettlementDescription>Заболотів</SettlementDescription>
	<SettlementAreaDescription>Івано-Франківська область</SettlementAreaDescription>
	<SettlementRegionsDescription>Снятинський р-н</SettlementRegionsDescription>
	<SettlementTypeDescription>селище міського типу</SettlementTypeDescription>
	<SettlementTypeDescriptionRu>поселок городского типа</SettlementTypeDescriptionRu>
	<Longitude>25.284086000000000</Longitude>
	<Latitude>48.467503000000000</Latitude>
	<PostFinance>1</PostFinance>
	<BicycleParking>0</BicycleParking>
	<PaymentAccess>0</PaymentAccess>
	<POSTerminal>1</POSTerminal>
	<InternationalShipping>1</InternationalShipping>
	<SelfServiceWorkplacesCount>0</SelfServiceWorkplacesCount>
	<TotalMaxWeightAllowed>0</TotalMaxWeightAllowed>
	<PlaceMaxWeightAllowed>1000</PlaceMaxWeightAllowed>
	<SendingLimitationsOnDimensions>
		<Width>170</Width>
		<Height>170</Height>
		<Length>300</Length>
	</SendingLimitationsOnDimensions>
	<ReceivingLimitationsOnDimensions>
		<Width>170</Width>
		<Height>170</Height>
		<Length>300</Length>
	</ReceivingLimitationsOnDimensions>
	<Reception>
		<Monday>16:45-18:00</Monday>
		<Tuesday>16:45-18:00</Tuesday>
		<Wednesday>16:45-18:00</Wednesday>
		<Thursday>16:45-18:00</Thursday>
		<Friday>16:45-18:00</Friday>
		<Saturday>16:30-17:00</Saturday>
		<Sunday>10:00-15:00</Sunday>
	</Reception>
	<Delivery>
		<Monday>08:00-12:00</Monday>
		<Tuesday>08:00-12:00</Tuesday>
		<Wednesday>08:00-12:00</Wednesday>
		<Thursday>08:00-12:00</Thursday>
		<Friday>08:00-12:00</Friday>
		<Saturday>09:00-12:00</Saturday>
		<Sunday>09:00-14:30</Sunday>
	</Delivery>
	<Schedule>
		<Monday>09:00-19:00</Monday>
		<Tuesday>09:00-19:00</Tuesday>
		<Wednesday>09:00-19:00</Wednesday>
		<Thursday>09:00-19:00</Thursday>
		<Friday>09:00-19:00</Friday>
		<Saturday>09:00-18:00</Saturday>
		<Sunday>10:00-18:00</Sunday>
	</Schedule>
	<DistrictCode>Ск За</DistrictCode>
	<WarehouseStatus>Working</WarehouseStatus>
	<WarehouseStatusDate>2013-04-02 00:00:00</WarehouseStatusDate>
	<CategoryOfWarehouse>Branch</CategoryOfWarehouse>
	<Direct></Direct>
	<RegionCity>ЧЕРНІВЦІ</RegionCity>
	<WarehouseForAgent>1</WarehouseForAgent>
	<MaxDeclaredCost>0</MaxDeclaredCost>
</data>
<info>
	<totalCount>1</totalCount>
</info>
</root>