API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Загрузить список контактных лиц Контрагента
Метод «getCounterpartyContactPerson», работает в модели «Counterparty», этот метод загружает список контактных лиц контрагентов.
Если в методе более чем 100 контактных лиц контрагентов, необходимо использовать параметр «Page»
"methodProperties": {
"Page": "22"
}
Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии. Рекомендуется проводить обновление справочников раз в сутки.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | Свойства метода | |
Ref | string[36] | Идентификатор контрагента |
Page | string[36] | Страница с информацией для отображения (не более 100 записей на одной странице) |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "getCounterpartyContactPersons",
"methodProperties": {
"Ref": "5953fb16-08d8-11e4-8958-0025909b4e33",
"Page": "1"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>Counterparty</modelName>
<calledMethod>getCounterpartyContactPersons</calledMethod>
<methodProperties>
<Ref>5953fb16-08d8-11e4-8958-0025909b4e33</Ref>
<Page>1</Page>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Description | string[50] | Контактное лицо |
Ref | string[36] | Идентификатор контактного лица |
Phones | string[50] | Телефон |
string[36] | Электронная почта | |
LastName | string[36] | Фамилия |
FirstName | string[36] | Имя |
MiddleName | string[36] | Отчество |
{
"success": true,
"data": [
{
"Description": "Іванов Іван Іванович",
"Ref": "9b9d5f71-6e3c-11e4-ab6d-005056801329",
"Phones": "380971155109",
"Email": "",
"LastName": "Іванов",
"FirstName": "Іван",
"MiddleName": "Іванович"
},
{
"Description": "Катчер Ештон Давидович",
"Ref": "344a7107-ccac-11e4-bdb5-005056801329",
"Phones": "380974534723",
"Email": "",
"LastName": "Катчер",
"FirstName": "Ештон",
"MiddleName": "Давидович"
},
{
"Description": "Ніксон Річард Американович",
"Ref": "1d9a04d4-ccac-11e4-bdb5-005056801329",
"Phones": "380673455434",
"Email": "",
"LastName": "Ніксон",
"FirstName": "Річард",
"MiddleName": "Американович"
},
{
"Description": "Янина Яна Игоревна",
"Ref": "cbe0a5f2-6e67-11e4-ab6d-005056801329",
"Phones": "380965989744",
"Email": "",
"LastName": "Янина",
"FirstName": "Яна",
"MiddleName": "Игоревна"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<data>
<element>
<Description>Іванов Іван Іванович</Description>
<Email />
<FirstName>Іван</FirstName>
<LastName>Іванов</LastName>
<MiddleName>Іванович</MiddleName>
<Phones>380971155109</Phones>
<Ref>9b9d5f71-6e3c-11e4-ab6d-005056801329</Ref>
</element>
<element>
<Description>Катчер Ештон Давидович</Description>
<Email />
<FirstName>Ештон</FirstName>
<LastName>Катчер</LastName>
<MiddleName>Давидович</MiddleName>
<Phones>380974534723</Phones>
<Ref>344a7107-ccac-11e4-bdb5-005056801329</Ref>
</element>
<element>
<Description>Ніксон Річард Американович</Description>
<Email />
<FirstName>Річард</FirstName>
<LastName>Ніксон</LastName>
<MiddleName>Американович</MiddleName>
<Phones>380673455434</Phones>
<Ref>1d9a04d4-ccac-11e4-bdb5-005056801329</Ref>
</element>
<element>
<Description>Янина Яна Игоревна</Description>
<Email />
<FirstName>Яна</FirstName>
<LastName>Янина</LastName>
<MiddleName>Игоревна</MiddleName>
<Phones>380965989744</Phones>
<Ref>cbe0a5f2-6e67-11e4-ab6d-005056801329</Ref>
</element>
</data>
<errors />
<info />
<success>true</success>
<warnings />
</root>