Портал для розробників-Address-getWarehouses

Довідник відділень та поштоматів

Метод «getWarehouses», працює в моделі «Address», цей метод завантажує довідник відділень «Нова пошта» в розрізі населених пунктів України.

Є можливість знайти необхідні відділення за наступними значеннями:

1) TypeOfWarehouseRef - тип відділення

2) PostFinance - наявність каси NovaPay

3) BicycleParking - наявність паркування

4) POSTerminal - наявність пос терміналу

5) CityName - по назві населеного пункуту

6) CityRef - за рефкою населеного пункту

7) Використовуя параметри CityName та FindByString можливо знайти конкретне відділення у обраномі населеному пункті або ж за идентифікатором відділення Ref

8) "WarehouseId": "номер відділення 151" - пошук відділення за його номером

9) Для отримання відділень у конкретному населеному пункті можна використовувати параметр SettlementRef, брати його з відповіді запиту getSettlements

Приклад використання переліченіх параметрів в запиті:

"methodProperties": {

"BicycleParking": "1",

"TypeOfWarehouseRef":"9a68df70-0267-42a8-bb5c-37f427e36ee4",

"PostFinance": "1",

"CityName":"Київ"

"CityRef": "20982d74-9b6c-11e2-a57a-d4ae527baec3",

"WarehouseId": "151",

"FindByString": "Відділення №8",

"Ref": "47402ec5-e1c2-11e3-8c4a-0050568002cf" //РЕФ відділення із довідника відділень,

"SettlementRef": "e71629ab-4b33-11e4-ab6d-005056801329" //РЕФ міста із довідника населенних пунктів України

}

Копію довідника необхідно зберігати та подтримувати в актуальному стані шляхом оновлення раз на добу.

Текст запиту

Параметр	Тип	Опис
CityName	string[36]	Додатковий фільтр по назві міста
CityRef	string[36]	Додатковий фільтр по ідентифікатору міста
Page	string[36]	Сторінка, максимум 500 записів на сторінці. Працює разом з параметром Limit
Limit	string[36]	Кільксть записів на сторінці. Працює разом із параметром Page
Language	string[2]	Відображення опису українською (ua) або російською (ru) мовами. За замовчанням завжди виводимо українською мовою
TypeOfWarehouseRef	string[36]	Тип відділення
WarehouseId	string[36]	Пошук віддлення за його номером

* Позначення обов’язкового параметру

                        
 
{
   "apiKey": "[ВАШ КЛЮЧ]",
   "modelName": "Address",
   "calledMethod": "getWarehouses",
   "methodProperties": {"CityName" : "Київ","CityRef" : "00000000-0000-0000-0000-000000000000","Page" : "1","Limit" : "50","Language" : "UA","TypeOfWarehouseRef" : "00000000-0000-0000-0000-000000000000","WarehouseId" : "151"   }
}

                                  

    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>Address</modelName>
                <calledMethod>getWarehouses</calledMethod>
                <methodProperties>
                    <CityName>Київ</CityName>
                    <CityRef>00000000-0000-0000-0000-000000000000</CityRef>
                    <Page>1</Page>
                    <Limit>50</Limit>
                    <Language>UA</Language>
                    <TypeOfWarehouseRef>00000000-0000-0000-0000-000000000000</TypeOfWarehouseRef>
                    <WarehouseId>151</WarehouseId>
                </methodProperties>
            </file>

Відповідь 200
Завжди повертає код 200 навіть при логічних помилках.

Тіло відповіді на запит

Параметр	Тип	Опис
SiteKey	string[10]	Код відділення
Description	string[99]	Назва відділення українською мовою
DescriptionRu	string[99]	Назва відділення російською мовою
ShortAddress	string[36]	Коротка адреса відділення українською мовою
ShortAddressRu	string[36]	Коротка адреса відділеня російською мовою
Phone	string[36]	Телефон
TypeOfWarehouse	string[36]	Тип відділення
Ref	string[36]	Ідентифікатор відділення
Number	string[36]	Номер відділення
CityRef	string[36]	Ідентифікатор населеного пункту
CityDescription	string[50]	Назва населеного пункту українською мовою
CityDescriptionRu	string[50]	Назва населеного пункту російською мовою
SettlementRef	string[36]	Реф населеного пункту
SettlementDescription	string[36]	Опис населеного пункту
SettlementAreaDescription	string[36]	Опис області
SettlementRegionsDescription	string[36]	Опис району
SettlementTypeDescription	string[36]	Тип населеного пункту українською мовою
SettlementTypeDescriptionRu	string[36]	Тип населеного пункту російською мовою
Longitude	float	Довгота
Latitude	float	Широта
PostFinance	string[36]	Наявність каси NovaPay (1/0)
BicycleParking	string[1]	Наявність паркування біля відділення (1/0)
PaymentAccess	string[1]	Доступність оплати у відділенні (1/0)
POSTerminal	string[36]	Наявність пос-терміналу на відділенні (1/0)
InternationalShipping	string[36]	Можливість оформлення міжнародного відправлення (1/0)
SelfServiceWorkplacesCount	string[1]	Наявність робочого місця самообслуговування (1/0)
TotalMaxWeightAllowed	string[36]	Максимальна вага відправлення
PlaceMaxWeightAllowed	string[36]	Максимальна вага одного місця відправлення
SendingLimitationsOnDimensions	object	Максимальні габарити відправлення для відправки
ReceivingLimitationsOnDimensions	object	Максимальні габарити відправлення для отримання
Reception	object	Графік приймання відправлень
Delivery	object	Графік відправки день в день
Schedule	object	Графік роботи
DistrictCode	string[36]	Код району
WarehouseStatus	string[36]	Статус відділення
WarehouseStatusDate	string[36]	Дата статусу відділення
CategoryOfWarehouse	string[36]	Категорія складу
RegionCity	string[36]	Область/місто
WarehouseForAgent	string[36]	Приналежність відділення до франчайзингової мережі (1/0)
MaxDeclaredCost	string[10]	Максимально допустима оціночна вартість відправлення
DenyToSelect	string[36]	Заборона вибору складу в ІД. Допустимі значення 0\1. Якщо встановлено 1, то з/на цей склад не можна створити документ
PostMachineType	string[36]	Тип поштомату. Допустимі значення: None - не зазначено тип поштомату, FullDayService - поштомат доступний 24/7, PartTime - поштомат з обмеженим графіком роботи (встановлений у ТЦ, магазині) і не має цілодобового доступу, ForResidentOfEntrance - для мешканців під'їзду Private - особистий, LimitedAccess - з обмеженим доступом, встановлений в організаціях за межами досяжності сторонніх осіб
PostalCodeUA	string[36]	Поштовий індекс адреси відділення (складу) Нової Пошти
OnlyReceivingParcel	string[36]	Ознака, що відділення працює тільки на видачу, якщо значення 1, якщо 0 - то відділення працює на приймання і на видачу
WarehouseIndex	string[36]	Цифрова адреса складу НП, де дані до слеша - це індекс населеного пункту, а після номер відділення/поштомату

                                  
{
  "success": true,
  "data": [{"SiteKey" : "10119","Description" : "Відділення №1: вул. М. Грушевського, 3","DescriptionRu" : "Отделение №1: ул. М. Грушевского, 3","ShortAddress" : "Заболотів, М. Грушевського, 3","ShortAddressRu" : "Заболотов, Грушевского, 3","Phone" : "380800500609","TypeOfWarehouse" : "00000000-0000-0000-0000-000000000000","Ref" : "00000000-0000-0000-0000-000000000000","Number" : "1","CityRef" : "00000000-0000-0000-0000-000000000000","CityDescription" : "Заболотів (Снятинський р-н)","CityDescriptionRu" : "Заболотов (Снятинский р-н)","SettlementRef" : "00000000-0000-0000-0000-000000000000","SettlementDescription" : "Заболотів","SettlementAreaDescription" : "Івано-Франківська область","SettlementRegionsDescription" : "Снятинський р-н","SettlementTypeDescription" : "селище міського типу","SettlementTypeDescriptionRu" : "поселок городского типа","Longitude" : "25.284086000000000","Latitude" : "48.467503000000000","PostFinance" : "1","BicycleParking" : "0","PaymentAccess" : "1","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" : "4/2/21 0:00","CategoryOfWarehouse" : "Branch","RegionCity" : "ЧЕРНІВЦІ","WarehouseForAgent" : "1","MaxDeclaredCost" : "0","DenyToSelect" : "1","PostMachineType" : "","PostalCodeUA" : "15001","OnlyReceivingParcel" : "0","WarehouseIndex" : "101/102"  }],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

                                   
<?xml version="1.0" encoding="UTF-8"?>
<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>00000000-0000-0000-0000-000000000000</TypeOfWarehouse>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <Number>1</Number>
        <CityRef>00000000-0000-0000-0000-000000000000</CityRef>
        <CityDescription>Заболотів (Снятинський р-н)</CityDescription>
        <CityDescriptionRu>Заболотов (Снятинский р-н)</CityDescriptionRu>
        <SettlementRef>00000000-0000-0000-0000-000000000000</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>1</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>4\/2\/21 0:00</WarehouseStatusDate>
        <CategoryOfWarehouse>Branch</CategoryOfWarehouse>
        <RegionCity>ЧЕРНІВЦІ</RegionCity>
        <WarehouseForAgent>1</WarehouseForAgent>
        <MaxDeclaredCost>0</MaxDeclaredCost>
        <DenyToSelect>1</DenyToSelect>
        <PostMachineType></PostMachineType>
        <PostalCodeUA>15001</PostalCodeUA>
        <OnlyReceivingParcel>0</OnlyReceivingParcel>
        <WarehouseIndex>101\/102</WarehouseIndex>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Спробувати API

Довідник відділень та поштоматів

Додаткові параметри

                                   
    <?xml version="1.0" encoding="UTF-8"?>
            <file>
                <apiKey>[ВАШ КЛЮЧ]</apiKey>
                <modelName>Address</modelName>
                <calledMethod>getWarehouses</calledMethod>
                <methodProperties>
                    
                </methodProperties>
            </file>