API Контрагенты

Работа с данными Контрагента

Загрузить список адресов Контрагентов

Метод «getCounterpartyAddresses», работает в модели «Counterparty», этот метод загружает список контрагентов отправителей/получателей.
Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии.
Рекомендуется проводить обновление справочников раз в месяц.

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   Свойства метода
Ref* string[36] Идентификатор контрагента
CounterpartyProperty* string[36] Cвойства контрагента
* Обозначение обязательного параметра 

Для Отправителя:

{
    "apiKey": "[ВАШ КЛЮЧ]",
 "modelName": "Counterparty",
 "calledMethod": "getCounterpartyAddresses",
 "methodProperties": {
 "Ref": "5ace4a2e-13ee-11e5-add9-005056887b8d",
 "CounterpartyProperty": "Sender" 
 }
}


Для Получателя:

{
    "apiKey": "[ВАШ КЛЮЧ]",
 "modelName": "Counterparty",
 "calledMethod": "getCounterpartyAddresses",
 "methodProperties": {
 "Ref": "5953fb16-08d8-11e4-8958-0025909b4e33",
 "CounterpartyProperty": "Recipient"
 }
}
Для Отправителя:

<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <calledMethod>getCounterpartyAddresses</calledMethod>
 <methodProperties>
 <CounterpartyProperty>Sender</CounterpartyProperty>
 <Ref>5ace4a2e-13ee-11e5-add9-005056887b8d</Ref>
 </methodProperties>
 <modelName>Counterparty</modelName>
</file>

Для Получателя:

<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <calledMethod>getCounterpartyAddresses</calledMethod>
 <methodProperties>
 <CounterpartyProperty>Recipient</CounterpartyProperty>
 <Ref>6e9acced-d072-11e3-95eb-0050568046cd</Ref>
 </methodProperties>
 <modelName>Counterparty</modelName>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор Контрагента
Description string[50] Адрес на Украинском языке 

{
 "success": true,
 "data": [
 {
 "Ref": "6e515680-b6b2-11e4-bdb5-005056801329",
 "Description": "Мостицька вул. 11"
 },
 {
 "Ref": "93ce9546-c0ca-11e4-bdb5-005056801329",
 "Description": "Хрещатик вул. 10"
 },
 {
 "Ref": "b136839d-6e67-11e4-ab6d-005056801329",
 "Description": "Червона вул. 1"
 }
 ],
 "errors": [],
 "warnings": [],
 "info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root><success>true</success>
<data>
<item>
<Ref>396537fe-b36b-11e4-a77a-005056887b8d</Ref>
<Description>1- Нова (Видубичі) вул. 10</Description>
</item>
<item>
<Ref>396537fd-b36b-11e4-a77a-005056887b8d</Ref>
<Description>1- Нова (Видубичі) вул. 10 кв. 1 1</Description>
</item>
<item>
<Ref>3965380c-b36b-11e4-a77a-005056887b8d</Ref>
<Description>1- Нова (Видубичі) вул. 10/2</Description>
</item>
<item>
<Ref>396537d3-b36b-11e4-a77a-005056887b8d</Ref>
<Description>Андріївська вул. 1</Description>
</item>
<item>
<Ref>20b8a0a1-00eb-11e4-acce-0050568002cf</Ref>
<Description>Андріївська вул. 12 кв. 11</Description>
</item>
<item>
<Ref>94de08c2-c8bf-11e4-a77a-005056887b8d</Ref>
<Description>Виноградна (Дарницький р-н) вул. 10</Description>
</item>
<item>
<Ref>04f916cc-7a02-11e4-acce-0050568002cf</Ref>
<Description>Драгоманова вул. 23Б кв. 139</Description>
</item>
<item>
<Ref>396538b8-b36b-11e4-a77a-005056887b8d</Ref>
<Description>Новокостянтинівська вул. 13/10</Description>
</item>
<item>
<Ref>39653b34-b36b-11e4-a77a-005056887b8d</Ref>
<Description>Новокостянтинівська вул. 15/10</Description>
</item>
<item>
<Ref>df8fb2ed-c0c1-11e4-a77a-005056887b8d</Ref>
<Description>Хрещатик вул. 10</Description>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>