Контактні персони

Створення, оновлення та видалення контактних осіб контрагентів

🔗Початок роботи з API

Створити контактну особу контрагента (JSON)

post

Метод save моделі ContactPersonGeneral (або ContactPerson) дозволяє створити контактну особу контрагента.

Зверніть увагу:

• Редагувати дані контактної особи можуть тільки юридичні особи.
• Приватні особи можуть редагувати лише телефон контактної особи контрагента.
• Редагування даних контрагента можливе лише до моменту створення інтернет-документа (ІД) із цим контрагентом.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (JSON)

application/json

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/

POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "ContactPersonGeneral",
  "calledMethod": "save",
  "methodProperties": {
    "CounterpartyRef": "00000000-0000-0000-0000-000000000000",
    "FirstName": "Іван",
    "LastName": "Іванов",
    "MiddleName": "Іванович",
    "Phone": "380997979789"
  }
}

200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Іванов Іван Іванович",
      "LastName": "Іванов",
      "FirstName": "Іван",
      "MiddleName": "Іванович",
      "Phones": "380997979789",
      "Email": "null"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Створити контактну особу контрагента (XML)

post

Метод save моделі ContactPersonGeneral (або ContactPerson) дозволяє створити контактну особу контрагента у форматі XML.

Зверніть увагу:

• Редагувати дані контактної особи можуть тільки юридичні особи.
• Приватні особи можуть редагувати лише телефон контактної особи контрагента.
• Редагування даних контрагента можливе лише до моменту створення інтернет-документа (ІД) із цим контрагентом.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (XML)

application/xml

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/

POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 493

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>ContactPersonGeneral</modelName>
    <calledMethod>save</calledMethod>
    <methodProperties>
        <CounterpartyRef>00000000-0000-0000-0000-000000000000</CounterpartyRef>
        <FirstName>Іван</FirstName>
        <LastName>Іванов</LastName>
        <MiddleName>Іванович</MiddleName>
        <Phone>380997979789</Phone>
    </methodProperties>
</file>
"

200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <Description>Іванов Іван Іванович</Description>
            <LastName>Іванов</LastName>
            <FirstName>Іван</FirstName>
            <MiddleName>Іванович</MiddleName>
            <Phones>380997979789</Phones>
            <Email>null</Email>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Оновити дані контактної особи контрагента (JSON)

post

Метод update працює в моделі ContactPerson (або ContactPersonGeneral) і використовується для оновлення контактної особи (відправника/отримувача).

Особливості редагування контактної особи

• Редагувати дані контактної особи можуть тільки юридичні особи.
• Приватні особи можуть редагувати лише телефон контактної особи контрагента.
• Редагування даних контактної особи можливе лише до моменту створення інтернет-документа (ІД) із цією контактною особою.

Body

apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

Назва моделі API

Example: ContactPersonGeneralPossible values:

calledMethodstring · enumRequired

Назва методу API

Example: updatePossible values:

Responses

200

Успішна відповідь (JSON)

application/json

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/

POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "ContactPersonGeneral",
  "calledMethod": "update",
  "methodProperties": {
    "CounterpartyRef": "00000000-0000-0000-0000-000000000000",
    "Ref": "00000000-0000-0000-0000-000000000000",
    "FirstName": "Іван",
    "LastName": "Іванов",
    "MiddleName": "Іванович",
    "Phone": "380997979789"
  }
}

200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000",
      "Description": "Іван Іванов Іванович",
      "LastName": "Іван",
      "FirstName": "Іванов",
      "MiddleName": "Іванович",
      "Phones": "380997979789",
      "Email": "null"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Оновити дані контактної особи контрагента (XML)

post

Метод update працює в моделі ContactPerson (або ContactPersonGeneral) і використовується для оновлення контактної особи (відправника/отримувача).

Особливості редагування контактної особи

• Редагувати дані контактної особи можуть тільки юридичні особи.
• Приватні особи можуть редагувати лише телефон контактної особи контрагента.
• Редагування даних контактної особи можливе лише до моменту створення інтернет-документа (ІД) із цією контактною особою.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (XML)

application/xml

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/

POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 552

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>ContactPersonGeneral</modelName>
    <calledMethod>update</calledMethod>
    <methodProperties>
        <CounterpartyRef>00000000-0000-0000-0000-000000000000</CounterpartyRef>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
        <FirstName>Іван</FirstName>
        <LastName>Іванов</LastName>
        <MiddleName>Іванович</MiddleName>
        <Phone>380997979789</Phone>
    </methodProperties>
</file>
"

200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
            <Description>Іван Іванов Іванович</Description>
            <LastName>Іван</LastName>
            <FirstName>Іванов</FirstName>
            <MiddleName>Іванович</MiddleName>
            <Phones>380997979789</Phones>
            <Email>null</Email>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>

Видалити контактну особу контрагента (JSON)

post

Метод delete працює в моделі ContactPerson (або ContactPersonGeneral) і використовується для видалення контактної особи контрагента (відправника/отримувача).

Особливості видалення контактної особи

• Видаляти дані контактної особи контрагента можуть лише юридичні особи.

Body

apiKeystringRequired

API-ключ користувача

Example: [ВАШ КЛЮЧ]

modelNamestring · enumRequired

Назва моделі API

Example: ContactPersonGeneralPossible values:

calledMethodstring · enumRequired

Назва методу API

Example: deletePossible values:

Responses

200

Успішна відповідь (JSON)

application/json

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/json/

POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "apiKey": "[ВАШ КЛЮЧ]",
  "modelName": "ContactPersonGeneral",
  "calledMethod": "delete",
  "methodProperties": {
    "Ref": "00000000-0000-0000-0000-000000000000"
  }
}

200

Успішна відповідь (JSON)

{
  "success": true,
  "data": [
    {
      "Ref": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}

Видалити контактну особу контрагента (XML)

post

Метод delete працює в моделі ContactPerson (або ContactPersonGeneral) і використовується для видалення контактної особи контрагента (відправника/отримувача).

Особливості видалення контактної особи

• Видаляти дані контактної особи контрагента можуть лише юридичні особи.

Body

apiKeystringRequired

API-ключ користувача

modelNamestring · enumRequired

Назва моделі API

Possible values:

calledMethodstring · enumRequired

Назва методу API

Possible values:

Responses

200

Успішна відповідь (XML)

application/xml

successbooleanRequired

Прапор успішності виконання запиту

errorsstring[]Required

Масив повідомлень про помилки

warningsstring[]Required

Масив попереджень

infostring[]Required

Масив інформаційних повідомлень

messageCodesstring[]Required

Масив кодів інформаційних повідомлень

errorCodesstring[]Required

Масив кодів помилок

warningCodesstring[]Required

Масив кодів попереджень

infoCodesstring[]Required

Масив кодів додаткової інформації

post/xml/

POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 299

"<?xml version="1.0" encoding="UTF-8"?>
<file>
    <apiKey>[ВАШ КЛЮЧ]</apiKey>
    <modelName>ContactPersonGeneral</modelName>
    <calledMethod>delete</calledMethod>
    <methodProperties>
        <Ref>00000000-0000-0000-0000-000000000000</Ref>
    </methodProperties>
</file>
"

200

Успішна відповідь (XML)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <success>true</success>
    <data>
        <item>
            <Ref>00000000-0000-0000-0000-000000000000</Ref>
        </item>
    </data>
    <errors/>
    <warnings/>
    <info/>
    <messageCodes/>
    <errorCodes/>
    <warningCodes/>
    <infoCodes/>
</root>