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

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

Обновить данные Контрагента

Метод «update», работает в модели «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 string Свойства метода
CityRef* string[36] Идентификатор города Контрагента
Ref* string[36] Идентификатор Контактного лица Контрагента
FirstName* string[36] Имя Контактного лица
LastName* string[36] Фамилия Контактного лица
MiddleName string[36] Отчество Контактного лица
Phone* string[36] Телефон Контактного лица
* Обозначение обязательного параметра

{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "Counterparty",
"calledMethod": "update",
"methodProperties": {
"Ref": "eb7c1c2e-cc85-11e4-bdb5-005056801329",
"CityRef": "db5c8911-391c-11dd-90d9-001a92567626",
"FirstName": "Михайло",
"MiddleName": "Іванович",
"LastName": "Колесник",
"Phone": "0991112222",
"Email": "",
"CounterpartyType": "PrivatePerson",
"CounterpartyProperty": "Recipient"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <apiKey>[ВАШ КЛЮЧ]</apiKey>
   <calledMethod>update</calledMethod>
   <methodProperties>
      <CityRef>db5c8911-391c-11dd-90d9-001a92567626</CityRef>
      <CounterpartyProperty>Recipient</CounterpartyProperty>
      <CounterpartyType>PrivatePerson</CounterpartyType>
      <Email />
      <FirstName>Михайло</FirstName>
      <LastName>Колесник</LastName>
      <MiddleName>Іванович</MiddleName>
      <Phone>0991112222</Phone>
      <Ref>eb7c1c2e-cc85-11e4-bdb5-005056801329</Ref>
   </methodProperties>
   <modelName>Counterparty</modelName>
</root>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор
Description string[36] Описание на Украинском языке
FirstName string[36] Имя
MiddleName string[36] Отчество
LastName string[36] Фамилия
Counterparty string[36]
OwnershipForm string[36] Идентификатор формы собствености
OwnershipFormDescription string[36] Описание формы собствености
EDRPOU int[36] код ОКПО
CounterpartyType string[36] Тип контрагента
ContactPerson string[36] Контактное лицо

{
"success": true,
"data": [
{
"Ref": "eb7c1c2e-cc85-11e4-bdb5-005056801329",
"Description": "Колесник Михайло Іванович",
"FirstName": "Михайло",
"MiddleName": "Іванович",
"LastName": "Колесник",
"Counterparty": "",
"OwnershipForm": "",
"OwnershipFormDescription": "",
"EDRPOU": "",
"CounterpartyType": "PrivatePerson",
"ContactPerson": {
"success": true,
"data": [],
"errors": [],
"warnings": [],
"info": []
}
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <data>
      <element>
         <ContactPerson>
            <data />
            <errors />
            <info />
            <success>true</success>
            <warnings />
         </ContactPerson>
         <Counterparty />
         <CounterpartyType>PrivatePerson</CounterpartyType>
         <Description>Колесник Михайло Іванович</Description>
         <EDRPOU />
         <FirstName>Михайло</FirstName>
         <LastName>Колесник</LastName>
         <MiddleName>Іванович</MiddleName>
         <OwnershipForm />
         <OwnershipFormDescription />
         <Ref>eb7c1c2e-cc85-11e4-bdb5-005056801329</Ref>
      </element>
   </data>
   <errors />
   <info />
   <success>true</success>
   <warnings />
</root>