API Контрагенты
Работа с данными Контрагента
- Создать Контрагента
- Создать контактное лицо Контрагента
- Создать Контрагента с типом (юридическое лицо) организация
- Создать Контрагента с типом третьего лица
- Загрузить список адресов Контрагентов
- Загрузить параметры Контрагента
- Загрузить список контактных лиц Контрагента
- Загрузить список Контрагентов отправителей/получателей/третье лицо
- Обновить данные Контрагента
- Обновить данные контактного лица Контрагента
- Удалить Контрагента получателя
- Удалить Контактное лицо Контрагента
Обновить данные контактного лица Контрагента
Метод «update», работает в модели «ContactPerson», этот метод необходим для обновления контактного лица контрагента отправителя/получателя.
Редактировать данные контактного лица контрагента могут только юридические лица.
Частные лица могут редактировать только телефон контактного лица Контрагента.
Редактировать данные Контрагента можно только с момента его создания до момента создания ИД с ним.
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 | string | Свойства метода |
CounterpartyRef* | string[36] | Идентификатор Контрагента |
Ref* | string[36] | Идентификатор Контактного лица Контрагента |
FirstName* | string[36] | Имя Контактного лица |
LastName* | string[36] | Фамилия Контактного лица |
MiddleName* | string[36] | Отчество Контактного лица |
Phone* | string[36] | Телефон Контактного лица |
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ContactPerson",
"calledMethod": "update",
"methodProperties": {
"CounterpartyRef": "768da332-159d-11e5-ad08-005056801333",
"Ref": "9ad69c2b-159d-11e5-ad08-005056801333",
"FirstName": "Иван",
"LastName": "Иванов",
"MiddleName": "Иванович",
"Phone": "+380997979789"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>update</calledMethod>
<modelName>ContactPerson</modelName>
<methodProperties>
<CounterpartyRef>9923679e-159e-11e5-ad08-005056801333</CounterpartyRef>
<Ref>862aa244-159f-11e5-ad08-005056801333</Ref>
<FirstName>Иван</FirstName>
<LastName>Иванов</LastName>
<MiddleName>Иванович</MiddleName>
<Phone>+380997979789</Phone>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
Description | string[36] | Описание на Украинском языке |
LastName | string[36] | Фамилия |
FirstName | string[36] | Имя |
MiddleName | string[36] | Отчество |
Phones | string[36] | Телефон |
string[36] | Имейл |
{
"success": true,
"data": [
{
"Ref": "9ad69c2b-159d-11e5-ad08-005056801333",
"Description": "Иван Иванов Иванович",
"LastName": "Иван",
"FirstName": "Иванов",
"MiddleName": "Иванович",
"Phones": "380997979789",
"Email": null
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data><item>
<Ref>862aa244-159f-11e5-ad08-005056801333</Ref>
<Description>Петров Петр Петрович</Description>
<LastName>Петров</LastName>
<FirstName>Петр</FirstName>
<MiddleName>Петрович</MiddleName>
<Phones>380997979789</Phones>
<Email/>
</item></data><errors/>
<warnings/><info/>
</root>